API Reference > Define settings for data collections > Delivery templates
  

Delivery templates

A delivery template contains the delivery format, the delivery method, and the location where the data is delivered to the Data User.

Create delivery templates

Use a REST API to create delivery templates in Data Marketplace.

Endpoint and method

The following table describes the connection properties for the API:
Property
Description
Endpoint
/api/v1/integration/provisioning/deliveryTemplates
Method
POST

Request

The following table describes the parameters that you enter in the body of the API payload:
Parameter
Description
Additional Information
refId
Optional. Enter a reference identifier for 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. Enter a name for the delivery template.
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. Enter a description for the delivery template.
-
color
Optional. Specify a 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. Specify a status for the delivery template. The status determines whether the delivery template is available to be used to create a delivery target of a data collection.
Enter one of the following values:
  • - To make the delivery template available, enter ACTIVE.
  • - To make the delivery template unavailable, enter INACTIVE.
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:
  • - If you set the parameter value to ENABLED, a unique data location is created for each order that is fulfilled using a target that is based on this template. Furthermore, an access management application such as Data Access Management might customize the data that it delivers based on the characteristics of the data, the Data User and the usage context that they specified in the order.
  • - If you set the parameter value to DISABLED, the same data is made available in a data location that is common to all Data Users.
For more information, see the Integrate Data Marketplace with other Informatica services topic in the Set Up Data Marketplace help.
deliveryType
Optional. Specify the type of delivery.
Enter one of the following values:
  • - If the delivery type is set to AUTOMATIC, the order approval and fulfillment is automated.
  • - If the delivery type is set to MANUAL, a stakeholder of the data collection must approve and fulfill the order manually.
templateOwners
Optional. Enter the system generated unique identifier of the user account to which you want to assign the Delivery Owner role. The Delivery Owner is responsible for the delivery template that you create.
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.
targetSystemReference
Required. Specify the default system where the data is delivered.
-
defaultPhysicalLocation
Required. Specify the default location where the data is delivered.
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 preceding location structure, you can configure the following properties:
  • - hostname. Enter the hostname of the data plane in Data Access Management.
  • - port. Enter the port number of the data plane in Data Access Management.
deliveryMethodIds
Required. Enter the system generated unique identifier of the delivery method.
For more information about how you can use an API to get the system generated unique identifier of a delivery method, see Retrieve delivery methods.
deliveryFormatIds
Required. Enter the system generated unique identifier of the delivery format.
For more information about how you can use an API to get the system generated unique identifier of a delivery format, see Retrieve delivery formats.

Example request

The following example shows how you can use an API to create a delivery template:
{
"items":[
{
"refId": "Template719",
"name":"XLSX via Hypercore",
"description":"Template to deliver an XLSX file via Hypercore.",
"color": "#10Be21",
"status":"ACTIVE",
"managedAccess": "DISABLED",
"deliveryType": "AUTOMATIC",
"templateOwners":[
"26sEOH2bGStfMSZtlK2UC0"
],
"targetSystemReference":"hyper://{public_key}{version}",
"defaultPhysicalLocation":"Hypercore",
"deliveryMethodIds":[
"fd24d20f-b97d-435f-b703-dc03c3e0280a"
],
"deliveryFormatIds":[
"b86a8588-3ec2-4eab-9504-8ff98a41187f"
]
}
]
}

Response

When you pass the API payload in the REST client, the client displays a response for the parameter values that you have entered.
The following example shows the response of an API call to create a delivery template:
{
"processingTime": 16702,
"objects": [
{
"index": 1,
"id": "72ab9726-359d-4c07-987e-febdcfb86906",
"refId": "Template719",
"name": "XLSX via Hypercore"
}
]
}
The following table describes the parameters of each delivery template that is created:
Parameter
Description
index
The position of the delivery template in the objects JSON array. This value does not impact how the delivery template is used by a Data Marketplace user.
id
System generated unique identifier of the delivery template.
refId
Reference identifier of the delivery template.
name
Name of the delivery template.

Retrieve delivery templates

Use a REST API to retrieve the details of delivery templates in Data Marketplace.

Endpoint and method

The following table describes the connection properties for the API:
Property
Description
Endpoint
/api/v1/integration/provisioning/deliveryTemplates
Method
GET
Note: Before you call this API, consider the following:
For more information, see How to call a Data Marketplace API.

Request

The following table describes the parameters that you enter in the request query:
Parameter
Description
Additional Information
search
Optional. Enter the search term that you want to use to find a delivery template.
Ensure that the search term that you enter don't contain an asterisk (*).
fields
Optional. Enter the fields on which the search term applies. The terms that you entered in the search field parameter are used to search the fields that you specify here.
Enter the following values:
  • - NAME
  • - DESCRIPTION
ids
Optional. Enter the system generated unique identifier of a delivery template.
To enter more than one value, use the following format:
ids=<value1>&ids=<value2>
status
Optional. Specify the status of the delivery template. The status indicates whether the delivery template is available to be used to create a delivery target of a data collection.
Enter one of the following values:
  • - To find the delivery templates that are available, enter ACTIVE.
  • - To find the delivery templates that aren't available, enter INACTIVE.
deliveryType
Optional. Specify the type of delivery.
Enter one of the following values:
  • - To find a delivery template of automatic type, enter AUTOMATIC. For orders where the delivery option is of automatic type, the approval and fulfillment is automated.
  • - To find a delivery template of manual type, enter MANUAL. For orders where the delivery option is of manual type, a stakeholder of the data collection must approve and fulfill the order manually.
isDefault
Optional. Specify whether to retrieve the default delivery template for Data Marketplace.
Enter one of the following values:
  • - To find a delivery template that is configured as the default delivery option for Data Marketplace, enter true.
  • - To find a delivery template that isn't configured as the default delivery option for Data Marketplace, enter false.
deliveryMethodIds
Optional. Enter the system generated unique identifier of the delivery method that is part of the delivery template.
For more information about how you can use an API to get the system generated unique identifier of a delivery method, see Retrieve delivery methods.
deliveryFormatIds
Optional. Enter the system generated unique identifier of the delivery format that is part of the delivery template.
For more information about how you can use an API to get the system generated unique identifier of a delivery format, see Retrieve delivery formats.
templateOwnerUserIds
Optional. Enter the system generated unique identifier of the Delivery Owner that manages 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 system generated unique identifier.
For example, in the URL /cloudUI/products/administer/main/usersAsset/0LH3xBJC9A6haZ26htGZyT, the system generated unique identifier is 0LH3xBJC9A6haZ26htGZyT.
createdDateFrom
Optional. To find delivery templates created between a date range, enter the starting date.
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.
If you have specified a value for the createdDateFrom parameter, ensure that you also enter a value for the createdDateTo parameter.
createdDateTo
Optional. To find delivery templates created between a date range, enter the ending date.
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.
If you have specified a value for the createdDateTo parameter, ensure that you also enter a value for the createdDateFrom parameter.
modifiedDateFrom
Optional. To find delivery templates modified between a date range, enter the starting date.
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.
If you have specified a value for the modifiedDateFrom parameter, ensure that you also enter a value for the modifiedDateTo parameter.
modifiedDateTo
Optional. To find delivery templates modified between a date range, enter the ending date.
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.
If you have specified a value for the modifiedDateTo parameter, ensure that you also enter a value for the modifiedDateFrom parameter.
sortByField
Optional. Specify the parameters to sort the search results.
To sort the search results, enter one of the following values:
  • - ID
  • - NAME
  • - TARGET_SYSTEM_REFERENCE
  • - STATUS
  • - CREATED_BY
  • - CREATED_ON
  • - MODIFIED_BY
  • - MODIFIED_ON
Default value is MODIFIED_ON.
sort
Optional. Set the sorting order of the search results.
Enter one of the following values:
  • - To sort the search results by ascending order, enter ASC.
  • - To sort the search results by descending order, enter DESC.
Default value is DESC.
offset
Optional. Enter the starting index for the paginated results.
Default value is 0.
limit
Optional. Enter the maximum number of results.
Default value is 50.
Maximum value is 100.
Note: The API has no payload.

Example request

The following example shows how you can use an API to retrieve the details of delivery template:
https://{{CDMP_URL}}/api/v1/integration/provisioning/deliveryTemplates?status=ACTIVE

Response

When you pass the API query parameters in the REST client, the client displays a response for the parameter values that you have entered.
The following example shows the response of an API call to retrieve the details of delivery template:
{

"processingTime":959,
"offset":0,
"limit":50,
"totalCount":153,
"objects"[
{
"id":"72ab9726-359d-4c07-987e-febdcfb86906",
"refId": "Template719",
"name":"XLSX via Hypercore",
"description":"Template to deliver an XLSX file via Hypercore.",
"color": "#10Be21",
"isDefault":false,
"status":"ACTIVE",
"managedAccess": "DISABLED",
"deliveryType": "MANUAL",
"templateOwners":[],
"targetSystemReference":"S3",
"defaultPhysicalLocation":"file",
"deliveryMethods":[
{
"id":"3c308736-5d9d-4a35-92a6-86dc213f4c5a",
"refId": "DMTD72",
"name":"Hypercore Protocol",
"status":"ACTIVE",
"createdBy":"f400dUqjPuaiJ9KBrzOhiB",
"createdOn":"2022-07-21T18:20:27.529Z",
"modifiedBy":"f400dUqjPuaiJ9KBrzOhiB",
"modifiedOn":"2022-07-21T18:20:27.529Z"
}
],
"deliveryFormats":[
{
"id":"8738df74-1413-4123-b370-b637249b5bfc",
"refId": "FMT8",
"name":"XLSX Workbook",
"status":"ACTIVE",
"createdBy":"f400dUqjPuaiJ9KBrzOhiB",
"createdOn":"2022-07-21T18:20:24.395Z",
"modifiedBy":"f400dUqjPuaiJ9KBrzOhiB",
"modifiedOn":"2022-07-21T18:20:24.395Z"
}
],
"createdBy":"f400dUqjPuaiJ9KBrzOhiB",
"createdOn":"2022-07-21T18:20:30.491Z",
"modifiedBy":"f400dUqjPuaiJ9KBrzOhiB",
"modifiedOn":"2022-07-21T18:20:30.491Z"
}
The following table describes the parameters of each delivery template that is retrieved:
Parameter
Description
offset
Starting index for paginated results.
limit
Maximum number of results.
totalCount
Number of delivery templates retrieved.
id
System generated unique identifier of the delivery template.
refId
Reference identifier of the delivery template.
name
Name of the delivery template.
description
Description of the delivery template.
color
A hexadecimal value that represents the color indicator of the delivery template.
isDefault
This parameter indicates whether or not the delivery template is set as the default delivery option for your Data Marketplace instance. The parameter can have one of the following values:
  • - true. The delivery template is the default delivery option.
  • - false. The delivery target isn't the default delivery option.
status
The status indicates whether the delivery template is available to be used to create a delivery target of a data collection. A delivery template can have one of the following statuses:
  • - ACTIVE. The delivery template is available.
  • - INACTIVE. The delivery template is unavailable.
managedAccess
This parameter indicates whether a unique data location is created for each order that is fulfilled using a target that is based on this template. This parameter can have one of the following values:
  • - ENABLED. A unique data location is created for each order that is fulfilled using a target that is based on this template. Furthermore, an access management application such as Data Access Management might customize the delivered data based on the characteristics of the data, the Data User and the usage context that they specified in the order.
  • - DISABLED. The same data is made available in a data location that is common to all Data Users.
For more information, see the Manage access to data with Data Access Management topic in the Set Up Data Marketplace help.
deliveryType
The type of delivery. A delivery template can have one of the following types:
  • - AUTOMATIC. The order approval and fulfillment is automated.
  • - MANUAL, a stakeholder of the data collection must approve and fulfill the order manually.
templateowners
Details of the Delivery Owner that is responsible for the delivery template.
targetSystemReference
Default system where the data is delivered.
defaultPhysicalLocation
Default location where the data is delivered.
deliveryMethods > id
System generated unique identifier of the delivery method of the delivery template.
deliveryMethods > refId
Reference identifier of the delivery method.
deliveryMethods > name
Name of the delivery method.
deliveryMethods > status
The status indicates whether the delivery method is available to be added to delivery templates. A delivery method can have one of the following statuses:
  • - ACTIVE. The delivery method is available.
  • - INACTIVE. The delivery method is not available.
deliveryMethods > createdBy
System generated unique identifier of the user account that created the delivery method.
deliveryMethods > createdOn
Date when the delivery method was created.
deliveryMethods > modifiedBy
System generated unique identifier of the latest user account that modified the delivery method.
deliveryMethods > modifiedOn
Latest date when the delivery method was modified.
deliveryFormats > id
System generated unique identifier of the delivery format of the delivery template.
deliveryFormats > refId
Reference identifier of the delivery format.
deliveryFormats > name
Name of the delivery format.
deliveryFormats > status
The status indicates whether the delivery format is available to be added to delivery templates. A delivery format can have one of the following statuses:
  • - ACTIVE. The delivery format is available.
  • - INACTIVE. The delivery format is not available.
deliveryFormats > createdBy
System generated unique identifier of the user account that created the delivery format.
deliveryFormats > createdOn
Date when the delivery format was created.
deliveryFormats > modifiedBy
System generated unique identifier of the latest user account that modified the delivery format.
deliveryFormats > modifiedOn
Latest date when the delivery format was modified.
createdBy
System generated unique identifier of the user account that created the delivery template.
createdOn
Date when the delivery template was created.
modifiedBy
System generated unique identifier of the latest user account that modified the delivery template.
modifiedOn
Latest date when the delivery template was modified.

Modify delivery templates

Use a REST API to modify delivery templates in Data Marketplace.

Endpoint and method

The following table describes the connection properties for the API:
Property
Description
Endpoint
/api/v1/integration/provisioning/deliveryTemplates
Method
PUT

Request

The following table describes the parameters that you enter in the body of the API payload:
Parameter
Description
Additional Information
id
Required. Enter the system generated unique identifier of the delivery template that you want to modify.
For more information about how you can use an API to get the system generated unique identifier of a delivery template, see Retrieve delivery templates.
refId
Optional. Enter a reference identifier for 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. Enter a name for the delivery template.
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. Enter a description for the delivery template.
-
color
Optional. Specify a 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. Specify a status for the delivery template. The status determines whether the delivery template is available to be used to create a delivery target of a data collection.
Enter one of the following values:
  • - To make the delivery template available, enter ACTIVE.
  • - To make the delivery template unavailable, enter INACTIVE.
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:
  • - If you set the parameter value to ENABLED, a unique data location is created for each order that is fulfilled using a target that is based on this template. Furthermore, an access management application such as Data Access Management might customize the delivered data based on the characteristics of the data, the Data User and the usage context that they specified in the order.
  • - If you set the parameter value to DISABLED, the same data is made available in a data location that is common to all Data Users.
For more information, see the Integrate Data Marketplace with other Informatica services topic in the Set Up Data Marketplace help.
deliveryType
Optional. Specify the type of delivery.
Enter one of the following values:
  • - If the delivery type is set to AUTOMATIC, the order approval and fulfillment is automated.
  • - If the delivery type is set to MANUAL, a stakeholder of the data collection must approve and fulfill the order manually.
templateOwners
Optional. Enter the system generated unique identifier of the user account to which you want to assign the Delivery Owner role. The Delivery Owner is responsible for the delivery template that you create.
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.
targetSystemReference
Required. Specify the default system where the data is delivered.
-
defaultPhysicalLocation
Required. Specify the default location where the data is delivered.
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:
  • - hostname. Enter the hostname for the Data Access Management proxy.
  • - port. Enter the port number of the Data Access Management proxy.
For more information about how you can retrieve the hostname and port values, see the Data Access Management Proxy service topic in the Secure Agent Services help in the Administrator.
deliveryMethodIds
Required. Enter the system generated unique identifier of the delivery method.
For more information about how you can use an API to get the system generated unique identifier of a delivery method, see Retrieve delivery methods.
deliveryFormatIds
Required. Enter the system generated unique identifier of the delivery format.
For more information about how you can use an API to get the system generated unique identifier of a delivery format, see Retrieve delivery formats.

Example request

The following example shows how you can use an API to modify a delivery template:

{
"items":[
{
"id": "72ab9726-359d-4c07-987e-febdcfb86906",
"refId": "Template719",
"name":"XLSX via Hypercore",
"description":"Template to deliver an XLSX file via Hypercore.",
"color": "#10Be21",
"status":"INACTIVE",
"managedAccess": "DISABLED",
"deliveryType": "MANUAL",
"templateOwners":[
"26sEOH2bGStfMSZtlK2UC0"
],
"targetSystemReference":"hyper://{public_key}{version}",
"defaultPhysicalLocation":"Hypercore",
"deliveryMethodIds":[
"fd24d20f-b97d-435f-b703-dc03c3e0280a"
],
"deliveryFormatIds":[
"b86a8588-3ec2-4eab-9504-8ff98a41187f"
]
}
]
}

Response

When you pass the API payload in the REST client, the client displays a response for the parameter values that you have entered.
The following example shows the response of an API call to modify a delivery template:
{
"processingTime": 16702,
"objects": [
{
"index": 1,
"id": "72ab9726-359d-4c07-987e-febdcfb86906",
"refId": "Template719",
"name": "XLSX via Hypercore"
}
]
}

The following table describes the parameters of each delivery template that is modified:
Parameter
Description
index
The position of the delivery template in the objects JSON array. This value does not impact how the delivery template is used by a Data Marketplace user.
id
System generated unique identifier of the delivery template.
refId
Reference identifier of the delivery template.
name
Name of the delivery template.