All Products
- All Products
Rename Saved Search
* This field is required
Confirm Deletion
Are you sure you want to delete the saved search?
Parameter
| Description
| Additional Information
|
|---|---|---|
refId
| Optional. The reference identifier of the consumer access.
| 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 .
|
status
| Optional. The status of the consumer access that you want to create.
| Enter one of the following values:
Default value is
AVAILABLE .
|
dataCollectionId
| Required. The system generated unique identifier of the data collection to which the Data User was granted access.
| 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 .
|
deliveryTargetId
| Required. The system generated unique identifier of the delivery target that was used to deliver the data.
| For more information about how you can use an API to get the unique identifier of a delivery target, see
Retrieve delivery targets.
|
consumerUserId
| Required. The system generated unique identifier of the user account that was granted access to the data collection.
| 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 unique identifier.
For example, in the URL
/cloudUI/products/administer/main/usersAsset/0LH3xBJC9A6haZ26htGZyT , the unique identifier is
0LH3xBJC9A6haZ26htGZyT .
|
accessGrantedOn
| Optional. The date on which the Data User was granted access to the data collection.
| To specify a date, use the
YYYY-MM-DD format. The value that you specify is automatically converted and stored in the Coordinated Universal Time (UTC) time standard.
|
usageContextId
| Optional. The system generated unique identifier of the usage type used to specify the context in which the data is to be used, as provided by the Data User that was granted access to the collection.
| For more information about how you can use an API to get the unique identifier of a usage type, see
Retrieve usage type.
|
costCenter
| Optional. The cost center of the Data User that was granted access to the data collection.
| -
|