June 24, 2017

1. Change in Response of GET requests of Entries and Assets

The 'publish_details' key that was available in the response of 'Get Entry', 'Get Entries', 'Get Asset' and 'Get Assets' API requests will be no longer returned by default. To include it in the response, use the 'include_publish_details' parameter.

Affected endpoints

Get Entries:

/v3/content_types/{content_type_id}/entries

Get Entry:

/v3/content_types/{content_type_id}/entries/{entry_id}

Get Assets:

/v3/assets/

Get Asset:

/v3/assets/{asset_id}

Webhook: All entry relevant webhook channel response

2. Change in response of GET requests of Entries and Assets for specific environment(s)

  • The 'publish_details' response key now contains the details of only the environment(s) specified in the 'environment' parameter, and not of all the environments.
  • The format of the 'publish_details' response key has been changed from array to JSON object.

Affected endpoints

Get Entries:

/v3/content_types/{content_type_id}/entries?environment={environment}

Get Entry:

/v3/content_types/{content_type_id}/entries/{entry_id}?environment={environment}

Get Assets:

/v3/assets/?environment={environment}

Get Asset:

/v3/assets/{asset_id}?environment={environment}

Webhook: All asset relevant webhook channel response

Example Response

{
"uid": "blte3458e663de6bef5",
...
...
"publish_details": {
          "environment": "blt381ebc884693ff29",
          "locale": "en-us",
          "version": 37,
          "user": "blt2a4852543181169c2e36d422",
          "time": "2017-05-17T19:16:26.983Z"
        },
...
}

3. Default disposition value of Images API changed to inline

When an image URL is opened in a browser, it now renders the image in the browser, instead of downloading it (which was the case earlier).

4. Maximum pagination limit set to 100 records

All endpoints will return a maximum of 100 records (changed from 1000 earlier). The next batch of records can be retrieved by making the same request and changing the 'skip' parameter to 100 from 0.

top-arrow