Sign in

v1

latestOpenAPI 3.0.02026-07-2417611.8 MB
Delivery sites

Get the descriptor of a public or protected page from a site.

Returns the descriptor of the page item specified by pageId. The page is contained in a site that is contained in siteId <br />User roles: admin, manager, editor, viewer, authenticatedVisitor

get/mydelivery/v1/sites/{siteId}/pages/{pageId}

Path parameters

pageIdstring uuid required

The ID of the page item.

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 page item.

namestring

The page item name.

segmentstring

The page segment name.

titlestring

The page title.

descriptionstring

The description text for this page item.

routestring

The route of this page item.

hideFromNavigationboolean

Indicates whether the page is hidden in the navigation view or not.

layoutIdstring

The name of the layoutitem for this page.

contentIdstring

The id of the content item which is associated with this page item.

contentTypeIdstring

The id of the content type of the page content.

contentStatusstring

The status of the content of this page. "ready" means that the content is in ready state.

urlstring

A relative url which locates this page item.

positionnumber

an ordinal value which determines the position of this page items in the order of page siblings

classificationstring

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

lastModifiedstring

The last modified date of this page 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 page 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

{
  "contentId": "980c6e51-1bf7-4fff-9386-b8e96aebf475",
  "contentTypeId": "2f313485-dccd-4b3c-ab9b-d049841b1e45",
  "description": "",
  "hideFromNavigation": true,
  "layoutId": "category-page-layout",
  "name": "CategoryDefaultPage",
  "segment": "categorydefaultpage",
  "title": "",
  "classification": "page",
  "lastModified": "2018-01-22T09:11:56.499Z",
  "lastModifierId": "52fb9c98-822f-4d6b-99ed-a8b5e04f3782",
  "contentStatus": "ready",
  "created": "2018-01-11T15:07:46.153Z",
  "creatorId": "52fb9c98-822f-4d6b-99ed-a8b5e04f3782",
  "position": 10,
  "route": "/categorydefaultpage",
  "id": "288c1fc1-48b5-48b9-8254-f8d596a3a64e",
  "url": "/664052ba-bdb9-49bf-8d33-dbe4a79b6520/categorydefaultpage"
}