close anchor

Types

To get information on types:

GET /types

Parameters

Param Type Description Optional
id string The UUID of an individual content type.
group string Indicate, by providing a comma-delimited list, the UUID of type or user group(s) by which to filter types. Include a '+' prefix before this list of groups if a type is to be identified with every group declared (the default behavior of this endpoint is to provide types in any of the group(s) included), and prefix an individual group therein with '!' to exclude types linked to it.
enabled boolean Indicate whether or not to filter types based on this property. Include a value of either true or false to indicate the types to be provided.
text string Include text by which to filter entries. Input will be parsed for up to ten keywords and treated as a filter, in that only entries with keyword(s) present in the fields below will be included.
fields string Indicate, by providing a comma-delimited list, the field(s) in which to expect text keyword(s) be present. If a field includes localized text, only values in the endpoint transaction locale will be queried. If empty or not provided, each of these valid fields will be included: description, name.
order string Indicate, by providing a comma-delimited list, the field(s) by which to order entries found. Include a '-' prefix if descending order is preferred in a given field ('+' is inferred by default). If empty or not provided, these valid fields will not be explicitly included: date_time.edit, date_time.init, id, name, ordinal.group (the default behavior of this endpoint is to provide types on the primary branch, or trunk, of the project tree first, in order by their position on that branch, then followed by non-primary type(s) in order by id).

If plural locales indicated for the endpoint transaction and name is present in the list of field(s) to order by, querying will be performed in the initial locale (but data will be included for each).

If ordinal.group is present in the field(s) to order by (dependent on a type group being indicated), this endpoint will deliver types in the preferred order for that group, if defined.
page integer Identify the page on which to begin delivering entries. If not provided, the default value of 1 will be inferred.
limit integer Indicate a total of up to 100 entries to be delivered. If not provided, the default value of 10 will be inferred.
data string Indicate, by providing a comma-delimited list, the data field(s) to be delivered by this endpoint. If empty or not provided, this endpoint will include by default each of the data field(s) identified with the type object.

The data object provided by this endpoint includes both a total (integer) of entries found, and an index (array) of type object(s).

To post a type:

POST /types

In order to post a content type, log in a user identified with owner-level privileges.

Parameters

Provide the input field(s) below as a JSON-encoded data object:

Param Type Description Optional
name string The name of the type, provided in the endpoint transaction locale.
description string The type description, provided in the endpoint transaction locale.
contacts boolean Indicate whether or not to permit contact(s) for content entries in this type.
include_linked_entries boolean Indicate whether or not to provide for linked content entries.
enabled boolean Indicate whether or not the type is to be enabled.

The data object provided by this endpoint is the type inserted to the project.

Errors

If there is an endpoint transaction failure, or a problem with user input data, an error is provided:

ID/Type Description
invalid_type_name The type name is an empty value or not provided.

If an error is not described on this page, the platform-wide error table provides further information.

To edit or update an individual type:

PUT /types

This endpoint provides for updating an individual content type's properties, the type(s) of which it is a parent, and the element(s) to be identified with it.

In order to edit or update a type, log in a user identified with owner-level privileges.

Parameters

Provide the input field(s) below as a JSON-encoded data object:

Param Type Description Optional
id string The UUID of the content type being updated.
name string The name of the type, provided in the endpoint transaction locale.
description string The type description, provided in the endpoint transaction locale.
contacts boolean Indicate whether or not to permit contact(s) for content entries in this type.
include_linked_entries boolean Indicate whether or not to provide for linked content entries.
enabled boolean Indicate whether or not the type is to be enabled.
types array The type(s) of which this type is a parent, being a one-dimensional array in which each value is the UUID of an individual type (not including either this type - it is not possible for a type to be a parent of itself - or any type(s) of which this type is a descendant), provided in the order to be delivered on this branch, for example by the /type/graph endpoint.
elements array The element(s) to be identified directly with this type, being a one-dimensional array in which each value is the UUID of an individual element, provided in the order to be delivered for this type. This is the order in which element(s) will be provided by the /content endpoint for an entry identified with this type, for instance.
groups object The type and/or user group(s) in which this type is to exist, or to which it is to be linked, each being a one-dimensional array in which each value is the UUID of an individual type or user group.

The type will no longer be identified with groups not included in this transaction. In order to post a type to a group individually (not deleting it from other groups in which it'd previously been included), use the /type/groups endpoint instead.
attributes object The entity-attribute-value data to be identified with this entity.

The data object provided by this endpoint is the updated type.

Errors

If there is an endpoint transaction failure, or a problem with user input data, an error is provided:

ID/Type Description
element_not_found The elements provided include an element which does not exist, or is not enabled for use, in this project. The data included for this error will be the ID of the element not found.
illegal_parent_type The types provided include this type or one of its existing parent type(s). The data included for this error will be the ID of the type in question.
invalid_type_name The type name provided is an empty value.
type_not_found The types provided include a type which does not exist in the project. The data included for this error will be the ID of the type not found.

If an error is not described on this page, the platform-wide error table provides further information.

To edit or update type positions:

PUT /types

This endpoint provides for updating the default order in which to deliver types on the primary branch, or trunk, of the project.

In order to edit or update type positions, log in a user identified with owner-level privileges.

Parameters

Provide the input field(s) below as a JSON-encoded data object:

Param Type Description
types array The content types in the project, being a one-dimensional, indexed array in which each value is the UUID of an individual type, provided in order by the desired position of each.

The data provided by this endpoint is the updated /type/graph for the project.

To delete a type:

DELETE /types

In order to delete a content type, log in a user identified with owner-level privileges.

Parameters

Param Type Description
id string The UUID of the content type being deleted.

The data object provided by this endpoint is the deleted type.

Errors

If there is an endpoint transaction failure, or a problem with user input data, an error is provided:

ID/Type Description
type_not_empty The type is not empty, being either a parent type or identified with content entries in the project, and therefore was not deleted.

If an error is not described on this page, the platform-wide error table provides further information.

Register for an Invitation
Thank you!
We'll be in touch.
First Name*
Last Name*
(optional) Business Name
Role*
Email*