v1

latestOpenAPI 3.0.02026-07-2417611.8 MB

Delivery sites

Get the site descriptor of a public or protected site.

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

get/mydelivery/v1/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 site item.

namestring

The site item name.

routingModestring

The routing mode. can be "path" or "anchor"

classificationstring

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

lastModifiedstring

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

lastModifierIdstring

The id of the user which applied the last modification of this item.

createdstring

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

creatorIdstring

The id of the user that created this item.

Example response

{
  "name": "Example site",
  "routingMode": "path",
  "classification": "site",
  "lastModified": "2018-01-22T09:11:53.100Z",
  "lastModifierId": "52fb9c98-822f-4d6b-99ed-a8b5e04f3782",
  "creatorId": "00000000-0000-0000-0000-000000000009",
  "created": "2018-01-10T12:01:57.188Z",
  "id": "949c298a-03c9-21b5-9386-b8ea3c3e0ee3"
}