Sign in

v1

latestOpenAPI 3.0.02026-07-2417611.8 MB
Authoring types

Retrieve a blank content type.

Use the /types/new end-point to get a blank content type document.<br />User roles: admin, manager, editor, viewer

get/authoring/v1/types/new

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 blank content type document back.

Response

Successfully retrieved a blank content 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
createdstring date-time

Optional creation date of this type document in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. Value is ignored if set in the future.

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.

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'

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"
  }
}