API Reference > Define settings for data collections > Delivery methods

Delivery methods

A delivery method represents the medium used to deliver the data to the Data User that ordered the collection.

Create delivery methods

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

Endpoint and method

The following table describes the connection properties for the API:

Property	Description
Endpoint	/api/v1/integration/provisioning/deliveryMethods
Method	POST

Request

The following table describes the parameters that you enter in the body of the API payload:

Parameter	Description
refId	Optional. Enter a reference identifier for the delivery method.	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 method.	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 method as "SFTP" while a delivery method called "sftp" already exists, the API call fails.
status	Required. Specify a status for the delivery method. The status indicates whether a delivery method is available to be added to delivery templates.	Enter one of the following values: - To make the delivery method available, enter ACTIVE. - To make the delivery method unavailable, enter INACTIVE.

Example request

The following example shows how you can use an API to create a delivery method:

{
"items": [
{
"refId": "DMTD71",
"name": "Hypercore Protocol",
"status": "INACTIVE"
}
]
}

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 method:

{
"processingTime": 17626,
"objects": [
{
"index": 1,
"id": "770dfbc0-v5t6-4e24-ba47-4477bb9bf33e",
"refId": "DMTD71",
"name": "Hypercore Protocol"
}
]
}

The following table describes the parameters of each delivery method that is created:

Parameter	Description
index	The position of the delivery method in the objects JSON array. This value does not impact how the delivery method is used by a Data Marketplace user.
id	System generated unique identifier of the delivery method.
refId	Reference identifier of the delivery method.
name	Name of the delivery method.

Retrieve delivery methods

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

Endpoint and method

The following table describes the connection properties for the API:

Property	Description
Endpoint	/api/v1/integration/provisioning/deliveryMethods
Method	GET

Note: Before you call this API, consider the following:

•If you use an Application Integration system service action to invoke this API, you can call a maximum of 100 APIs per minute.
•If you use JWT authentication to invoke this API, you can call a maximum of 120 APIs per minute and 10,000 APIs per day.

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 method.	Ensure that the search term that you enter don't contain an asterisk (*).
ids	Optional. Enter the system generated unique identifier of the delivery method.	To enter more than one value, use the following format: ids=<value1>&ids=<value2>
status	Optional. Specify the status of the delivery method. The status indicates whether a delivery method is available to be added to delivery templates.	Enter one of the following values: - To find the delivery methods that are available, enter ACTIVE. - To find the delivery methods that aren't available, enter INACTIVE.
createdDateFrom	Optional. To find the delivery method 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 converted automatically to the Coordinated Universal Time (UTC) time standard. If you have specified a value for the createdDateFrom parameter, ensure that you enter a value for the createdDateTo parameter.
createdDateTo	Optional. To find the delivery method 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 converted automatically to the Coordinated Universal Time (UTC) time standard. If you have specified a value for the createdDateTo parameter, ensure that you enter a value for the createdDateFrom parameter.
modifiedDateFrom	Optional. To find the delivery method 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 converted automatically to the Coordinated Universal Time (UTC) time standard. If you have specified a value for the modifiedDateFrom parameter, ensure that you enter a value for the modifiedDateTo parameter.
modifiedDateTo	Optional. To find the delivery method 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 converted automatically to the Coordinated Universal Time (UTC) time standard. If you have specified a value for the modifiedDateTo parameter, ensure that you 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 - 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 method:

https://{{CDMP_URL}}/api/v1/integration/provisioning/deliveryMethods?search=SK&ids=909668e3-f91d-4cde-a7d5-e3dca316ce97&status=ACTIVE&createdDateFrom=2022-01-12&createdDateTo=2022-12-12&modifiedDateFrom=2022-01-12&modifiedDateTo=2022-12-12&sortByField=NAME&sort=DESC&offset=0&limit=2

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 method:

{
"processingTime": 2988,
"offset": 0,
"limit": 2,
"totalCount": 1,
"objects": [
{
"id": "770dfbc0-v5t6-4e24-ba47-4477bb9bf33e",
"refId": "DMTD71",
"name": "Hypercore Protocol"
"status": "ACTIVE",
"createdBy": "9Wqbp1IRIqfltN12yjs3qt",
"createdOn": "2022-06-03T06:27:07.853Z",
"modifiedBy": "9Wqbp1IRIqfltN12yjs3qt",
"modifiedOn": "2022-06-03T06:30:34.676Z"
}
]
}

The following table describes the parameters of each delivery method that is retrieved:

Parameter	Description
Offset	Starting index for paginated results.
limit	Maximum number of results.
totalCount	Number of delivery methods retrieved.
id	System generated unique identifier of the delivery method.
refId	Reference identifier of the delivery method.
name	Name of the delivery method.
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.
CREATED_BY	System generated unique identifier of the user account that created the delivery method.
CREATED_ON	Date when the delivery method was created.
MODIFIED_BY	System generated unique identifier of the user account that last modified the delivery method.
MODIFIED_ON	Latest date when the delivery method was modified.

Modify delivery methods

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

Endpoint and method

The following table describes the connection properties for the API:

Property	Description
Endpoint	/api/v1/integration/provisioning/deliverymethods
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 method 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 method, see Retrieve delivery methods.
refId	Optional. Enter a reference identifier for the delivery method.	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 method.	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 method as "SFTP" while a delivery method called "sftp" already exists, the API call fails.
status	Required. Specify a status for the delivery method. The status indicates whether a delivery method is available to be added to delivery templates.	Enter one of the following values: - To make the delivery method available, enter ACTIVE. - To make the delivery method unavailable, enter INACTIVE.

Example request

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

{
"items": [
{
"id": "770dfbc0-v5t6-4e24-ba47-4477bb9bf33e",
"refId": "DMTD71",
"name": "Hypercore Protocol",
"status": "INACTIVE"
}
]
}

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 method:

{
"processingTime": 16702,
"objects": [
{
"index": 1,
"id": "770dfbc0-v5t6-4e24-ba47-4477bb9bf33e",
"refId": "DMTD71",
"name": "Hypercore Protocol"
}
]
}

The following table describes the parameters of each delivery method that is modified:

Parameter	Description
index	The position of the delivery method in the objects JSON array. This value does not impact how the delivery method is used by a Data Marketplace user.
id	System generated unique identifier of the delivery method.
refId	Reference identifier of the delivery method.
name	Name of the delivery method.