Retrieve an existing element definition.

get

https://example.com/authoring/v1/elementdefs/{id}

Use the /elementdefs/{id} end-point to retrieve an existing element definition 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

User roles: admin, manager, editor, viewer

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Provide the ID of the element definition that you want to retrieve.

Query Params

fields

string

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.

include

string

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.

Headers

If-None-Match

string

Provide an Etag value from a previous request to check whether the element definition retrieved is the most recent version. If the element definition is the most recent version, the call returns a 304 ( Not modified) message instead of sending the element definition back.

Responses

304

Not modified. The Etag value that you provided in the If-Match parameter matches the recent document version.

200Successfully retrieved the element definition that matches the ID provided from the database.

404The element definition with ID {id} was not found or the current tenant's database is not provisioned.

429Too Many Requests, the server has reached a limit, the request must be sent again at a later time.