ASK INFAPreview
Parameter
| Description
| Additional Information
|
|---|---|---|
refId
| Optional. The reference identifier of the delivery target.
| 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 .
|
name
| Required. Name of the delivery target that you want to create.
| Ensure that you enter a unique value.
Data Marketplace doesn't consider the letter case when it verifies the uniqueness of the
name parameter's value. For example, if you try to name a delivery target as "Excel over ipfs" while a delivery target called "Excel over IPFS" already exists, the API call fails.
|
description
| Required. Description of the delivery target.
| -
|
status
| Required. Status of the delivery target.
| Enter one of the following values:
|
targetSystemReference
| Optional. Target system or resource reference from where the data is obtained.
| -
|
physicalLocation
| Optional. URL of the delivery location.
| If the
Managed Access option is enabled for the deliver template that you specified in the
deliveryTemplateId parameter, the data won't be delivered to the location that you specify in the
physicalLocation parameter. Instead, the data will be delivered to a location that is generated at the time of order fulfillment. The generated location is unique to each order that is fulfilled using this target.
For more information, see the
Use Data Access Management to streamline the Data Marketplace order process topic in the
Set Up Data Marketplace help.
|
deliveryTemplateId
| Required. The system generated unique identifier of the delivery template that you want to use to create the delivery target.
| For more information about how you can use an API to get the unique identifier of a delivery template, see
Retrieve delivery templates.
|
deliveryMethodId
| Required. The system generated unique identifier of the delivery method that constitutes the delivery target.
| For more information about how you can use an API to get the unique identifier of a delivery method, see
Retrieve delivery methods.
|
deliveryFormatId
| Required. The system generated unique identifier of the delivery format that constitutes the delivery target.
| For more information about how you can use an API to get the unique identifier of a delivery format, see
Retrieve delivery formats.
|
dataCollectionId
| Required. The system generated unique identifier of the data collection that is delivered to the delivery target.
| To get the unique identifier of a data collection, 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 .
For more information about how you can use an API to get the unique identifier of a data collection, see
Retrieve data collections.
If the
Managed Access option is enabled for the deliver template that you specified in the
deliveryTemplateId parameter, ensure that the data collection that you specify in the
dataCollectionId parameter is comprised only of data assets that belong to the same data source. For more information about how you can add data assets to a data collection, see
Add or remove data assets from data collections.
|
