v1

latestOpenAPI 3.0.02026-07-2417611.8 MB

Authoring types

Retrieve all type documents in the database ordered by last modified date.

Use the /types/views/by-modified endpoint to retrieve all type documents from the database and list them in the order of their last modified date.<br />User roles: admin, manager, editor, viewer

get/authoring/v1/types/views/by-modified

Query parameters

startstring date-time

Provide the date and time of when the last modifications were made to the content types that you want returned. When the order is ascending (default), the content types that are modified on or after this date and time are returned. When the order is descending, the content types that are modified on or before this date and time are returned. The date value must be in the ISO 8601 format YYYY-MM-DD T hh:mm:ss:sssZ.

endstring date-time

Provide the date and time of when the last modifications were made to the content types that you want returned. When the order is ascending (default), the content types that are modified on or before this date and time are returned. When the order is descending, the content types that are modified on or after this date and time are returned. The date value must be in the ISO 8601 format YYYY-MM-DD T hh:mm:ss:sssZ.

startIdstring

If start does not uniquely identify the result to start from, you can specify the UUID of the result as startId.

endIdstring

If end does not uniquely identify the result to end at, you can specify the UUID of the result as endId.

offsetnumber

Use the offset parameter to specify the number of type documents to skip and return the rest.

limitnumber

Set the limit for the number of type documents that are returned.

format'feed' | 'array' | 'sequence'

Specify the result format.

feed - (default) returns a wrapper with links
array - returns just the array of results
sequence - each result is a separate JSON document on a new line

pageMode'offset' | 'deep'

Specify the next and previous page link mode.

offset - (default) allows paging forward or backwards, but only a small number of times
deep - uses index keys to efficiently page through a large result set, but only in one direction

order'ascending' | 'descending'

Specify whether you want the type documents to be returned in ascending/oldest-first (default) or descending/newest-first order.

fieldsstring

Only the content type fields that are specified here are returned for each result. Any type document field is a valid value and can be specified as a comma-separated list.

includestring

Specify additional fields to include with each result. Valid options are:

links: Adds the 'links' section (see '#/definitions/DocumentLinks') to the response.
all: Adds all current and future additional fields to the response.

When used in-conjunction with the 'fields' option, both the fields that are specified in the 'fields' option and the fields in the 'include' option are returned.

Response

All content type documents that are requested are listed in the order of the last modified date.

offsetinteger

number of results to skip.

limitinteger

number of results to return.

hrefstring

the url of the current query.

nextstring

the url for the next page of results. Only present if there are more results.

previousstring

the url for the previous page of results. Not present when on the first page.

Example response

{
  "items": [
    {
      "path": "/myTypes/SampleType.json",
      "thumbnail": {
        "id": "6c622bbb-5f5b-45d4-89e1-fce1c054138f",
        "path": "/sales/images/hub.png",
        "url": "/authoring/v1/resources/47d535ff288b3bd8383009abf82a9ea8"
      }
    }
  ]
}