ASK INFAPreview
Parameter
| Description
| Additional Information
|
|---|---|---|
id
| Required. 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 unique identifier of a data collection, see
Retrieve data collections.
To get the unique identifier of a data collection from the
Data Marketplace interface, open the data collection. The data collection page's URL contains the unique identifier.
For example, in the URL
https://{{CDMP_URL}}/datacollection/25158afc-3dfb-44ef-8f3e-cec1e171d0f1?dtn=&tab=summary , the unique identifier is
25158afc-3dfb-44ef-8f3e-cec1e171d0f1 .
|
name
| Required. Name of the data collection that you want to modify.
| -
|
description
| Required. Description of the data collection that you want to modify.
| -
|
refId
| Optional. Reference identifier of 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. The system generated unique identifier of the category in which the data collection that you want to modify exists.
| For more information about how you can use an API to get the unique identifier of a category, see
Retrieve categories.
To get the unique identifier of a category from the
Data Marketplace interface, open the category. The category page's URL contains the unique identifier.
For example, in the URL
https://{{CDMP_URL}}/category/view?ac=67417f72-e5ab-44f0-add9-a1e412c1ce13&dtn=_AfterEBF%20may20 , the unique identifier is
67417f72-e5ab-44f0-add9-a1e412c1ce13 .
|
usageContextIds
| Optional. 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 unique identifier of a usage type, see
Retrieve usage type.
|
dataCollectionStatus
| Required. The status informs you of whether or not the data collection is available to Data Users.
| Enter one of the following values:
|
dataOwners
| Optional. The system generated unique identifier of the user account or user group that you want to assign as the Data Owner of the data collection.
|
|
technicalOwners
| Optional. The system generated unique identifier of the user account or user group that you want to assign as the Technical Owner of the data collection.
|
|
customFields
| You can 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 fields for objects topic in the
Set Up Data Marketplace help.
|
customFields > name
| 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
| The custom field value.
| This parameter can have only a single value.
|
customFields > values
| The custom field value.
| This parameter can have multiple values.
|
