ASK INFAPreview
Parameter
| Description
| Additional Information
|
|---|---|---|
id
| Required. The system generated unique identifier of a delivery template.
| For more information about how you can use an API to get the unique identifier of a delivery template, see
Retrieve delivery templates.
|
refId
| Optional. The reference identifier of the delivery template.
| 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 template 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 template as "Excel over ipfs" while a delivery template called "Excel over IPFS" already exists, the API call fails.
|
description
| Required. Description of the delivery template that you want to create.
| -
|
color
| Optional. The color indicator for the delivery template. Assigning a unique color indicator allows
Data Marketplace users to identify a delivery template easily.
| Enter the hexadecimal value that represents the color that you want to use.
|
status
| Required. Status of the delivery template.
| Enter one of the following values:
|
managedAccess
| Optional. This parameter determines whether the data is customized and is made available in a data location that is unique to each order fulfilled using a target that uses this template.
| Enter one of the following values:
For more information, see the
Use Data Access Management to streamline the Data Marketplace order process topic in the
Set Up Data Marketplace help. For more information about how the data is customized, see the
Data Access Management help.
|
deliveryType
| Optional. The type of delivery.
| Enter one of the following values:
|
templateOwners
| Optional. The details of the Delivery Owner that is responsible for the delivery template.
| 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 .
|
targetSystemReference
| Required. Target system or resource reference from where the data is obtained.
| -
|
defaultPhysicalLocation
| Required. URL of the default delivery location.
| If you set the
managedAccess parameter value to
ENABLED , ensure that you use the following structure to specify the data location:
hostname :port In the location structure, you can configure the following properties:
|
deliveryMethodIds
| Required. The system generated unique identifier of the delivery method.
| For more information about how you can use an API to get the unique identifier of a delivery method, see
Retrieve delivery methods.
|
deliveryFormatIds
| Required. The system generated unique identifier of the delivery format.
| For more information about how you can use an API to get the unique identifier of a delivery format, see
Retrieve delivery formats.
|
