Sign in

v1

latestOpenAPI 3.0.02026-07-2417611.8 MB
Authoring resources

Retrieve all resources created within the specified date range.

Use this endpoint to retrieve all resources that was created within the date range specified.<br />User roles: admin, manager, editor, viewer

get/authoring/v1/resources/views/by-created

Query parameters

startstring date-time

Provide the date and time of when the resource was created. Resources that were created 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. Note: when reversing the order you do not switch start and end.

endstring date-time

Provide the date and time of when the resource was created. Resources that were created 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. Note: when reversing the order you do not switch start and end.

startIdstring

If start does not uniquely identify the result to start from, you can specify the UUID of the result as startId. Note: when reversing the order you do not switch start and end ids.

endIdstring

If end does not uniquely identify the result to end at, you can specify the UUID of the result as endId. Note: when reversing the order you do not switch start and end ids.

limitnumber

Set the limit for the maximum number of resource items to return in a single result. The default value is 50. You can pass 0 to unset the limit and stream all available results. A streaming parser can be avoided with format=sequence.

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
offsetnumber

Use the offset parameter to specify the number of resource items to skip from the beginning of the list and return the rest. Note: large offsets perform poorly. Use start keys to index into large result sets. Also see pageMode.

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 the order of the results.

  • ascending - (default) result keys are increasing
  • descending - result keys are decreasing

It is not necessary to switch the start and end keys and ids when reversing the order.

Response

Successfully lists a paged result view of all resources that was created within the date range specified.

limitinteger required

The page size.

offsetinteger required

The number of items to skip from the beginning of the list.

hrefstring required

A link to the current page.

nextstring

A link to the next page. Only shown if a next page exists.

previousstring

A link to the previous page. Only shown if a previous page exists.

Example response

{
  "items": [
    {
      "id": "2322e04f11e47edbc6505ad8294ebd70"
    }
  ]
}