XaitCPQ API

GET page/{name}

Get Page description containing list of all views.

Request Information

URI

https://ofd-api.blueprintcpq.net/page/{name}?share={share}

URI Parameters

NameDescriptionTypeAdditional information
name

Page name.

 string

Required
share

Optional share identifier.

 globally unique identifier

None.

Body Parameters

None.

Response Information

Resource Description

Page definition.

PageResponse
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.
Name

string

None.
PluralName

string

None.
Views

Collection of PageTemplateResponse

None.

Response Formats

application/json, text/json

Sample: 
{
  "Id": "54494dd4-8626-4b63-a4b4-4033707d6560",
  "Name": "sample string 2",
  "PluralName": "sample string 3",
  "Views": [
    {
      "TemplateId": "2b06a115-8e23-42fb-bce5-fe9ae4e4ca0e",
      "Name": "sample string 2",
      "AllowUnauthenticatedAccess": true,
      "EnableContextualChat": true,
      "Shortcuts": [
        {
          "Shortcut": "sample string 1",
          "Action": "sample string 2"
        },
        {
          "Shortcut": "sample string 1",
          "Action": "sample string 2"
        }
      ]
    },
    {
      "TemplateId": "2b06a115-8e23-42fb-bce5-fe9ae4e4ca0e",
      "Name": "sample string 2",
      "AllowUnauthenticatedAccess": true,
      "EnableContextualChat": true,
      "Shortcuts": [
        {
          "Shortcut": "sample string 1",
          "Action": "sample string 2"
        },
        {
          "Shortcut": "sample string 1",
          "Action": "sample string 2"
        }
      ]
    }
  ]
}

text/html

Sample: 
{"Id":"54494dd4-8626-4b63-a4b4-4033707d6560","Name":"sample string 2","PluralName":"sample string 3","Views":[{"TemplateId":"2b06a115-8e23-42fb-bce5-fe9ae4e4ca0e","Name":"sample string 2","AllowUnauthenticatedAccess":true,"EnableContextualChat":true,"Shortcuts":[{"Shortcut":"sample string 1","Action":"sample string 2"},{"Shortcut":"sample string 1","Action":"sample string 2"}]},{"TemplateId":"2b06a115-8e23-42fb-bce5-fe9ae4e4ca0e","Name":"sample string 2","AllowUnauthenticatedAccess":true,"EnableContextualChat":true,"Shortcuts":[{"Shortcut":"sample string 1","Action":"sample string 2"},{"Shortcut":"sample string 1","Action":"sample string 2"}]}]}

application/xml, text/xml

Sample: 
<PageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shared.Models.Responses">
  <Id>54494dd4-8626-4b63-a4b4-4033707d6560</Id>
  <Name>sample string 2</Name>
  <PluralName>sample string 3</PluralName>
  <Views>
    <PageTemplateResponse>
      <AllowUnauthenticatedAccess>true</AllowUnauthenticatedAccess>
      <EnableContextualChat>true</EnableContextualChat>
      <Name>sample string 2</Name>
      <Shortcuts>
        <PageTemplateShortcutResponse>
          <Action>sample string 2</Action>
          <Shortcut>sample string 1</Shortcut>
        </PageTemplateShortcutResponse>
        <PageTemplateShortcutResponse>
          <Action>sample string 2</Action>
          <Shortcut>sample string 1</Shortcut>
        </PageTemplateShortcutResponse>
      </Shortcuts>
      <TemplateId>2b06a115-8e23-42fb-bce5-fe9ae4e4ca0e</TemplateId>
    </PageTemplateResponse>
    <PageTemplateResponse>
      <AllowUnauthenticatedAccess>true</AllowUnauthenticatedAccess>
      <EnableContextualChat>true</EnableContextualChat>
      <Name>sample string 2</Name>
      <Shortcuts>
        <PageTemplateShortcutResponse>
          <Action>sample string 2</Action>
          <Shortcut>sample string 1</Shortcut>
        </PageTemplateShortcutResponse>
        <PageTemplateShortcutResponse>
          <Action>sample string 2</Action>
          <Shortcut>sample string 1</Shortcut>
        </PageTemplateShortcutResponse>
      </Shortcuts>
      <TemplateId>2b06a115-8e23-42fb-bce5-fe9ae4e4ca0e</TemplateId>
    </PageTemplateResponse>
  </Views>
</PageResponse>