Retrieve a page state

Request

Fetches basic information about a page (identifier, display name and revision) and optionally workflow, layout and version data.

Security

Bearer

Path

pageIdstringrequired

The page identifier.

Example:8f0b81bc-7388-46be-b109-6e73d1114470

Query

Sitestringrequired

The site name.

Example:Site=my-site

Languagestringrequired

The language of the page.

Example:Language=en-US

Versioninteger, (int32)

The version number of the page.

Example:Version=2

WithWorkflowboolean

Whether to include workflow information.

Example:WithWorkflow=true

WithVersionsboolean

Whether to include page versions.

Example:WithVersions=true

WithLayoutboolean

Whether to include layout information.

Example:WithLayout=true

environmentIdstring

The identifier of the environment.

Example:environmentId=main

curl -i -X GET \
  'https://xmapps-api.sitecorecloud.io/api/v1/pages/8f0b81bc-7388-46be-b109-6e73d1114470/state?Site=my-site&Language=en-US&Version=2&WithWorkflow=true&WithVersions=true&WithLayout=true&environmentId=main' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json

idstring or null

The page identifier. Example value: 8f0b81bc-7388-46be-b109-6e73d1114470

Example:"8f0b81bc-7388-46be-b109-6e73d1114470"

displayNamestring or null

The display name of the page. Example value: Site Home

Example:"Site Home"

revisionstring or null

The revision of the page. Example value: f7d29433-001e-4a35-a744-876759dba468

Example:"f7d29433-001e-4a35-a744-876759dba468"

workflowobject(PageWorkflow)

versionsArray of objects or null(Page)

The versions of the page.

finalLayoutstring or null

The final layout of the page. Example value: {"devices":[{"id":"fe5d7fdf-89c0-4d99-9aa3-b5fbd009c9f3","layoutId":"96e5f4ba-a2cf-4a4c-a4e7-64da88226362","placeholders":[],"renderings":[{"id":"9c6d53e3-fe57-4638-af7b-6d68304c7a94","instanceId":"ad5e15fb-896b-4415-8735-5e4d6b1543e1","placeholderKey":"headless-main","dataSource":"local:/Data/Text 1","parameters":{"GridParameters":"{7465D855-992E-4DC2-9855-A03250DFA74B}","FieldNames":"{940B57D1-13EA-429D-8C7E-2F6C1307B1B1}","Styles":"","RenderingIdentifier":"","CSSStyles":"","DynamicPlaceholderId":"1"}}]}]}

Example:"{\\\"devices\\\":[{\\\"id\\\":\\\"fe5d7fdf-89c0-4d99-9aa3-b5fbd009c9f3\\\",\\\"layoutId\\\":\\\"96e5f4ba-a2cf-4a4c-a4e7-64da88226362\\\",\\\"placehol

sharedLayoutstring or null

The shared layout of the page. Example value: {"devices":[{"id":"fe5d7fdf-89c0-4d99-9aa3-b5fbd009c9f3","layoutId":"96e5f4ba-a2cf-4a4c-a4e7-64da88226362","placeholders":[],"renderings":[]}]}

Example:"{\\\"devices\\\":[{\\\"id\\\":\\\"fe5d7fdf-89c0-4d99-9aa3-b5fbd009c9f3\\\",\\\"layoutId\\\":\\\"96e5f4ba-a2cf-4a4c-a4e7-64da88226362\\\",\\\"placehol

layoutEditingKindstring or null

The kind of layout for editing (Shared of Final). Example value: Final

Example:"Final"

Response

{
  "id": "8f0b81bc-7388-46be-b109-6e73d1114470",
  "displayName": "Site Home",
  "revision": "f7d29433-001e-4a35-a744-876759dba468",
  "workflow": {
    "id": "77ac7ce9-803a-42e3-bb05-f79fca73cbce",
    "displayName": "Page Workflow",
    "finalState": true,
    "canEdit": true,
    "warnings": [ … ],
    "icon": "Applications/32x32/document_heart.png",
    "commands": [ … ]
  },
  "versions": [
    { … }
  ],
  "finalLayout": "{\\\"devices\\\":[{\\\"id\\\":\\\"fe5d7fdf-89c0-4d99-9aa3-b5fbd009c9f3\\\",\\\"layoutId\\\":\\\"96e5f4ba-a2cf-4a4c-a4e7-64da88226362\\\",\\\"placeholders\\\":[],\\\"renderings\\\":[{\\\"id\\\":\\\"9c6d53e3-fe57-4638-af7b-6d68304c7a94\\\",\\\"instanceId\\\":\\\"ad5e15fb-896b-4415-8735-5e4d6b1543e1\\\",\\\"placeholderKey\\\":\\\"headless-main\\\",\\\"dataSource\\\":\\\"local:/Data/Text 1\\\",\\\"parameters\\\":{\\\"GridParameters\\\":\\\"{7465D855-992E-4DC2-9855-A03250DFA74B}\\\",\\\"FieldNames\\\":\\\"{940B57D1-13EA-429D-8C7E-2F6C1307B1B1}\\\",\\\"Styles\\\":\\\"\\\",\\\"RenderingIdentifier\\\":\\\"\\\",\\\"CSSStyles\\\":\\\"\\\",\\\"DynamicPlaceholderId\\\":\\\"1\\\"}}]}]}",
  "sharedLayout": "{\\\"devices\\\":[{\\\"id\\\":\\\"fe5d7fdf-89c0-4d99-9aa3-b5fbd009c9f3\\\",\\\"layoutId\\\":\\\"96e5f4ba-a2cf-4a4c-a4e7-64da88226362\\\",\\\"placeholders\\\":[],\\\"renderings\\\":[]}]}",
  "layoutEditingKind": "Final"
}