Sign in

v1

latestOpenAPI 3.0.02026-07-2417611.8 MB
Authoring types

Retrieve an existing type by its path.

Use the /types/by-path end-point to retrieve an existing content type from the database.<br />User roles: admin, manager, editor, viewer

get/authoring/v1/types/by-path

Query parameters

pathstring required

The path of the content type to retrieve.

fieldsstring

A comma separated list that when specified, limits the fields returned to just those specified. Any type document field is a valid value.

includestring

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

  • links: Adds the 'links' section (see '#/definitions/DocumentLinks') to the response.
  • metadata: Adds additional details such as creator and last modifier to the response.
  • schema: Adds the 'schema' section to the response.
  • mappings: Add the 'mappings' section 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-Matchstring

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

Response

Success.

idstring

The ID of the type document.

revstring required

The current revision of the type document.

namestring required

The name of the type document.

descriptionstring required

The description of the type document.

classification'content-type' required

the type document classification.

kindstring[]

Identifies the sub-classification of the type document. Valid values include:

  • custom-ui: This type document has a custom user interface defined
  • embedded: This type document can be included within another type document
  • standalone: This type document can be used to create normal content items
  • page: This type document can be used to create site pages
  • landing-page: This type document can be used to create landing pages
  • email: This type document can be used to create email messages
  • site: This type document can be used to create sites
creatorIdstring required
creatorstring

The display name of the user that created this Type document. This field is only returned when the 'include' query string option is set to 'ALL' or 'metadata'. This field is read only.

createdstring date-time

The created date of this type document in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.

lastModifierIdstring
lastModifierstring

The display name of the last user that modified this Type document. This field is only returned when the 'include' query string option is set to 'ALL' or 'metadata'. This field is read only.

lastModifiedstring date-time

The last modified date of this type document in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.

pathstring

Optional path to associate with this type document. Must be unique. Will default to filesystem friendly version of /[NAME].

tagsstring[] required
status'draft' | 'ready' | 'retired' required

the workflow status.

linkedDocIdstring

Only present on Drafts created from existing Ready items, this property indicates the ID of the associated Ready item

iconstring[]

Specifies the type of icon to show for this type document within the Type user interface's element palette Only used when the type document has a kind that includes 'embedded'

schemaobject

The Json-Schema representation of this Type document, which can be used to validate a content-item using this Type. This is the same document returned from the '/types/{id}/schema' end-point and is only returned when the 'include' query string option is set to 'ALL' or 'schema'

mappingsobject

The layout mappings of this Type document. This field is only returned when the 'include' query string option is set to 'ALL' or 'mappings'.

isSystemboolean

Indicates whether this item is a 'system item' or not.

Example response

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