v1

latestOpenAPI 3.0.02026-07-2417611.8 MB

Delivery sites

Get the site descriptor of a public site

Returns the site descriptor of the site specified by siteId. <br />User roles: admin, manager, editor, viewer, authenticatedVisitor, anonymous

get/delivery/v2/sites/{siteId}

Path parameters

siteIdstring uuid required

The ID of the site item, or @current to indicate that the ID of the site is derived from the addressed URL via custom domain site mapping or URL path based site addressing. For further details consult the Content documentation.

Query parameters

fieldsstring

Reduce the returned content down to just the specified fields. Fields specified by a comma seperated list of field names and should only be used once in query string. To only retrieve id and name this parameter should look like id,name. Undefined fields are ignored.

Headers

If-None-Matchstring

The Etag value from a previous request to check whether a content item has been updated since, if so, a 304 (Not Modified) response code is returned instead of the content item.

Response

Success

idstring

The ID of the content item.

namestring

The name of the content item.

descriptionstring

The description text for this content item.

classificationstring

The classification defines the document type. For site items, all documents are classified as "content".

typeIdstring

The ID of the content type this item belongs to.

localestring

locale of the document (e.g "en", or "de").

lastModifiedstring date-time

The last modified date of this content item in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ.

lastModifierIdstring

name of user for now, this property may change once user management is defined.

createdstring date-time

The created date of this content item in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ.

creatorIdstring

The Id of the user that created this content item.

kindstring[]

tagsstring[]

The tags which has been set for this content item.

elementsobject

Defined by the type and capture in the schema given by the type, in a real content, this property will be filled with more information.

typestring

this is the Id of the content type document this content is based on.