API Reference > Define settings for data collections > Delivery formats

Delivery formats

A delivery format object represents the format in which the data is delivered.

Create delivery formats

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

Endpoint and method

The following table describes the connection properties for the API:

Property	Description
Endpoint	/api/v1/integration/provisioning/deliveryFormats
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 format.	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 format.	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 format as "Excel" while a delivery format called "excel" already exists, the API call fails.
status	Required. Specify a status for the delivery format. The status determines whether a delivery format is available to be added to delivery templates.	Enter one of the following values: - To make the delivery format available, enter ACTIVE. - To make the delivery format unavailable, enter INACTIVE.

Example request

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

{
"items": [
{
"refId": "FMT9",
"name": "XLSX_Workbook",
"status": "ACTIVE"
}
]
}

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

{
"processingTime": 17626,
"objects": [
{
"index": 1,
"id": "980dfbc0-c7c0-4e24-ba47-4477bb9bf19c",
"refId": "FMT9",
"name": "XLSX_Workbook"
}
]
}

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

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

Retrieve delivery formats

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

Endpoint and method

The following table describes the connection properties for the API:

Property	Description
Endpoint	/api/v1/integration/provisioning/deliveryFormats
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
ids	Optional. Enter the system generated unique identifier of a delivery format.	To enter more than one value, use the following format: ids=<value1>&ids=<value2>
search	Optional. Enter the search term that you want to use to find a delivery format.	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
createdDateFrom	Optional. To find delivery format 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 format 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 format 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 modifiedDateFrom parameter, ensure that you also enter a value for the modifiedDateTo parameter.
modifiedDateTo	Optional. To find delivery format 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 modifiedDateTo parameter, ensure that you also enter a value for the modifiedDateFrom parameter.
status	Optional. Specify the status of the delivery format. The status indicates whether a delivery format is available to be added to delivery templates.	Enter one of the following values: - To find the delivery formats that are available, enter ACTIVE. - To find the delivery formats that aren't available, enter INACTIVE.
sortByField	Optional. Specify the parameters to sort the search results.	To sort the search results, enter one of the following values: - NAME - STATUS - ID - 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 format:

https://{{CDMP_URL}}/api/v1/integration/provisioning/deliveryFormats

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 a delivery format:

{
"processingTime": 0,
"offset": 0,
"limit": 0,
"totalCount": 0,
"objects": [
{
"id": "980dfbc0-c7c0-4e24-ba47-4477bb9bf19c",
"refId": "FMT9",
"name": "XLSX_Workbook",
"status": "ACTIVE"
}
]
}

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

Parameter	Description
Offset	Starting index for paginated results.
limit	Maximum number of results.
totalCount	Number of delivery formats retrieved.
id	System generated unique identifier of the delivery format.
refId	Reference identifier of the delivery format.
name	Name of the delivery format.
status	The status indicates whether a 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.

Modify delivery formats

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

Endpoint and method

The following table describes the connection properties for the API:

Property	Description
Endpoint	/api/v1/integration/provisioning/deliveryFormats
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 format that you want to modify.	For more information about how you can use an API to get the unique identifier of a delivery format, see Retrieve delivery formats.
refId	Optional. Enter a reference identifier for the delivery format.	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 format.	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 format as "Excel" while a delivery format called "excel" already exists, the API call fails.
status	Required. Specify a status for the delivery format. The status determines whether a delivery format is available to be added to delivery templates.	Enter one of the following values: - To make the delivery format available, enter ACTIVE. - To make the delivery format unavailable, enter INACTIVE.

Example request

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

{
"items": [
{
"id": "980dfbc0-c7c0-4e24-ba47-4477bb9bf19c",
"refId": "FMT9",
"name": "XLSX Workbook",
"status": "ACTIVE"
}
]
}

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

{
"processingTime": 16702,
"objects": [
{
"index": 1,
"id": "980dfbc0-c7c0-4e24-ba47-4477bb9bf19c",
"refId": "FMT9",
"name": "XLSX_Workbook"
}
]
}

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

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