API Reference

Back Next

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	The system generated unique identifier of the delivery format.
refId	The reference identifier of the delivery format.
name	Name of the delivery format.