Modify data collections

Property	Description
Endpoint	/api/v1/integration/dataCollections
Method	PUT

Parameter	Description	Additional Information
id	Required. Enter the system generated unique identifier of the data collection that you want to modify.	For more information about how you can use an API to get the system generated unique identifier of a data collection, see Retrieve data collections. To get the system generated unique identifier of a data collection from the Data Marketplace interface, open the data collection. The data collection page's URL contains the system generated unique identifier. For example, in the URL https://{{CDMP_URL}}/datacollection/25158afc-3dfb-44ef-8f3e-cec1e171d0f1?dtn=&tab=summary, the system generated unique identifier is 25158afc-3dfb-44ef-8f3e-cec1e171d0f1.
name	Required. Enter a name for the data collection.	-
description	Required. Enter a description for the data collection.	-
refId	Optional. Enter a reference identifier for the data collection.	If you don't specify a reference identifier, Data Marketplace automatically assigns a unique value to the object. The reference identifier that Data Marketplace automatically generates contains a prefix. The Administrator can specify the prefix of the automatically generated reference identifier in Metadata Command Center. If you want to specify a reference identifier, ensure that you enter a unique value. Ensure that you don't use the prefix value that is configured in Metadata Command Center.
categoryId	Required. Enter the system generated unique identifier of the category to which you want to add the data collection.	For more information about how you can use an API to get the system generated unique identifier of a category, see Retrieve categories. To get the system generated unique identifier of a category from the Data Marketplace interface, open the category. The category page's URL contains the system generated unique identifier. For example, in the URL https://{{CDMP_URL}}/category/view?ac=67417f72-e5ab-44f0-add9-a1e412c1ce13&dtn=_AfterEBF%20may20, the system generated unique identifier is 67417f72-e5ab-44f0-add9-a1e412c1ce13.
usageContextIds	Optional. Enter the system generated unique identifier of the usage type that you want to use to specify the certified use of the data collection.	For more information about how you can use an API to get the system generated unique identifier of a usage type, see Retrieve usage type.
dataCollectionStatus	Required. Specify a status for the data collection. The status determines whether or not the data collection is available to Data Users.	Enter one of the following values: - To make the data collection discoverable to Data Users, enter PUBLISHED. - To make the data collection undiscoverable to Data Users, enter UNPUBLISHED.
dataOwners	Optional. Enter the system generated unique identifier of the user account or user group that is assigned as a stakeholder on the data collection with the Data Owner stakeholder role.	- To get the system generated unique identifier of a user account, navigate to My Services > Administrator > Users. On the Users page, click a user account. The user account page's URL contains the system generated unique identifier. For example, in the URL /cloudUI/products/administer/main/usersAsset/0LH3xBJC9A6haZ26htGZyT, the system generated unique identifier is 0LH3xBJC9A6haZ26htGZyT. - To get the system generated unique identifier of a user group, navigate to My Services > Administrator > User Groups. On the User Groups page, click a user group. The user group page's URL contains the system generated unique identifier. For example, in the URL /cloudUI/products/administer/main/userGroupsAsset/90uizkSWg0ycuu7hSNXSW4, the system generated unique identifier is 90uizkSWg0ycuu7hSNXSW4.
technicalOwners	Optional. Enter the system generated unique identifier of the user account or user group that is assigned as a stakeholder on the data collection with the Technical Owner stakeholder role.	- To get the system generated unique identifier of a user account, navigate to My Services > Administrator > Users. On the Users page, click a user account. The user account page's URL contains the system generated unique identifier. For example, in the URL /cloudUI/products/administer/main/usersAsset/0LH3xBJC9A6haZ26htGZyT, the system generated unique identifier is 0LH3xBJC9A6haZ26htGZyT. - To get the system generated unique identifier of a user group, navigate to My Services > Administrator > User Groups. On the User Groups page, click a user group. The user group page's URL contains the system generated unique identifier. For example, in the URL /cloudUI/products/administer/main/userGroupsAsset/90uizkSWg0ycuu7hSNXSW4, the system generated unique identifier is 90uizkSWg0ycuu7hSNXSW4.
customFields	Use custom fields to specify additional information about the data collection.	Whether you must enter a value or not enter a value in a custom field is determined by how the custom field was defined by your Administrator in Metadata Command Center. Custom fields are additional properties for Data Marketplace objects that are defined by your Administrator in Metadata Command Center. For more information about custom fields, see the Create custom attributes for objects topic in the Set Up Data Marketplace help.
customFields > name	Enter the system generated unique identifier of the custom field.	For more information about how you can retrieve the system generated unique identifier of a custom field, see Retrieve custom fields.
customFields > value	Enter a value in the custom field.	This parameter can have only a single value.
customFields > values	Enter a value in the custom field.	This parameter can have multiple values.

{
"items": [
{
"id": "15100e3a-0c89-42c7-afc1-9ed0f13766a4",
"name":"07/08 J-SOX Reports",
"description": "The collection of J-SOX reports from 2007-08.",
"refId": "123467",
"categoryId": "2d0a40a4-a511-4d64-915b-d700d6441efe",
"usageContextIds": [
"c607b766-1e04-4892-a105-3ef2826461c9"
],
"dataCollectionStatus": "PUBLISHED",
"dataOwners": [
"48WAxPi970Jkn9p2PCoJCb"
],
"technicalOwners": [
"6WExNvGf1Mpj9BITKmPMeg"
],
"customFields": [
{
"name": "com.infa.odin.models.custom.ca_7821688086685433570",
"value": true
},
{
"name": "com.infa.odin.models.custom.ca_3184028726397751640",
"value": "2023-09-05"
},
{
"name": "com.infa.odin.models.custom.ca_6928840635020975219",
"value": 45.6
},
{
"name": "com.infa.odin.models.custom.ca_7907323524500803261",
"value": "Secure Data Transfer"
},
{
"name": "com.infa.odin.models.custom.ca_1535512762047882544",
"value": 10
},
{
"name": "com.infa.odin.models.custom.ca_8610145587620226269",
"value": "Reticulum"
},
{
"name": "com.infa.odin.models.custom.ca_5588843841075376340",
"value": "LXMF"
},
{
"name": "com.infa.odin.models.custom.ca_1007408542741800522",
"value": true
},
{
"name": "com.infa.odin.models.custom.ca_3068304325528979652",
"values": [
"Apache CloduStack",
"Microsoft Azure",
"Amazong Web Services"
]
}
]
}
]
}

Modify data collections

Endpoint and method

Request

Example request

Response

Parameter	Description
index	The position of the data collection in the objects JSON array. This value does not impact how the data collection is used by a Data Marketplace user.
id	System generated unique identifier of the data collection.
refId	Reference identifier of the data collection.
name	Name of the data collection.