v1

latestOpenAPI 3.0.02026-07-2417611.8 MB
Authoring types

Retrieve all element definitions in the database.

Use the /elementdefs endpoint to retrieve all element definitions from the database.

Each element definition describes a variety of element that can be added to a content type.

To programmatically create a content-type, merge the 'elementFragment' attribute into the 'elements' attribute of the type, performing the following replacements: '$ELEMENT_KEY$': With the desired element key '$ELEMENT_LABEL$': With the desired element label <br />User roles: admin, manager, editor, viewer

get/authoring/v1/elementdefs

Query parameters

offsetnumber

Use the offset parameter to specify the number of element definitions to skip and return the rest.

limitnumber

Set the limit for the number of element definitions that are returned.

order'ascending' | 'descending'

Specify whether you want the element definitions to be returned in ascending or descending order.

fieldsstring

Only the element definition fields that are specified here are returned for each result. Any element definition 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

Successfully lists all element definitions that are requested.

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.