v1

latestOpenAPI 3.0.02026-07-2417611.8 MB
Delivery content

Retrieve filtered content items by id in bulk, including restricted ones.

Returns an array of requested filtered content items. This route is restricted to authenticated users and allows to access restricted content items too.

Sample request body for retrieving id and title fields of two content items with id '7f2335cc-d91d-4f52-9e26-2d9402e463c0' and '1067771c-ec05-4671-951b-18f503953f2d':

{
  "ids": ["7f2335cc-d91d-4f52-9e26-2d9402e463c0", "1067771c-ec05-4671-951b-18f503953f2d"],
  "fields": ["id", "title"]
}

For each content item requested ..

  • If a content item is not found for a specified id, the content retrieval for that id is skipped.
  • If a specified field is not found in the content, it will not be present in the response.
  • If no fields are specified for filtering, the whole content item is returned.
  • The ids array cannot be empty and hence, there should be at least one id specified for lookup.
  • A maximum of 25 content items can be retrieved at once. If the ids field is found to have more entries, only the first 25 content items requested are returned. <br />User roles: admin, manager, editor, viewer, authenticatedVisitor
post/mydelivery/v1/content/bulk_retrieve

Headers

Content-Typestring required

Content type of the request body, should be 'application/json'.

Request body

idsstring[] required

An array of ids that should be retrieved by this bulk request.

fieldsstring[]

An array of fields that should be returned by this bulk request.

Response

Success

idstring

The ID of the content item.

namestring

The name of the content item.

descriptionstring

The description text for this content item.

classificationstring

The classification defines the document type. For content items, all documents are classified as "content".

typeIdstring

The ID of the content type this item belongs to.

localestring

locale of the document (e.g "en", or "de").

lastModifiedstring date-time

The last modified date of this content item in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ.

lastModifierIdstring

name of user for now, this property may change once user management is defined.

createdstring date-time

The created date of this content item in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ.

creatorIdstring

The Id of the user that created this content item.

tagsstring[]

The tags which has been set for this content item.

elementsobject

Defined by the type and capture in the schema given by the type, in a real content, this property will be filled with more information.

kindstring[]

The tags which has been set by AI.

typestring

This is the Id of the content type document this content is based on.