XaitCPQ API

GET page/pinnedmenu

Gets the pinned menu.

Request Information

URI

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

URI Parameters

NameDescriptionTypeAdditional information
share

Optional share identifier.

 globally unique identifier

None.

Body Parameters

None.

Response Information

Resource Description

The pinned menu.

Collection of PinnedPageMenu
NameDescriptionTypeAdditional information
Alignment

MenuItemAlignment

None.
Id

globally unique identifier

None.
Text

string

None.
IconClass

string

None.
Order

integer

None.
Display

MenuItemDisplay

None.
Type

MenuItemType

None.
Hyperlink

string

None.
OpenInNewWindow

boolean

None.
Pinned

boolean

None.
PageTemplate

PageMenuPageTemplate

None.
PageTemplateAction

string

None.
ChildPageMenus

Collection of PageMenu

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "Alignment": 0,
    "Id": "579a38ca-1a4f-4e6a-b522-9592eca2807d",
    "Text": "sample string 2",
    "IconClass": "sample string 3",
    "Order": 4,
    "Display": 0,
    "Type": 0,
    "Hyperlink": "sample string 5",
    "OpenInNewWindow": true,
    "Pinned": true,
    "PageTemplate": {
      "PageName": "sample string 1",
      "PageTemplateName": "sample string 2"
    },
    "PageTemplateAction": "sample string 8",
    "ChildPageMenus": [
      {
        "Id": "fa96d699-fc67-4e74-a4e5-f6fd288723bc",
        "Text": "sample string 2",
        "IconClass": "sample string 3",
        "Order": 4,
        "Display": 0,
        "Type": 0,
        "Hyperlink": "sample string 5",
        "OpenInNewWindow": true,
        "Pinned": true,
        "PageTemplate": {
          "PageName": "sample string 1",
          "PageTemplateName": "sample string 2"
        },
        "PageTemplateAction": "sample string 8",
        "ChildPageMenus": []
      },
      {
        "Id": "fa96d699-fc67-4e74-a4e5-f6fd288723bc",
        "Text": "sample string 2",
        "IconClass": "sample string 3",
        "Order": 4,
        "Display": 0,
        "Type": 0,
        "Hyperlink": "sample string 5",
        "OpenInNewWindow": true,
        "Pinned": true,
        "PageTemplate": {
          "PageName": "sample string 1",
          "PageTemplateName": "sample string 2"
        },
        "PageTemplateAction": "sample string 8",
        "ChildPageMenus": []
      }
    ]
  },
  {
    "Alignment": 0,
    "Id": "579a38ca-1a4f-4e6a-b522-9592eca2807d",
    "Text": "sample string 2",
    "IconClass": "sample string 3",
    "Order": 4,
    "Display": 0,
    "Type": 0,
    "Hyperlink": "sample string 5",
    "OpenInNewWindow": true,
    "Pinned": true,
    "PageTemplate": {
      "PageName": "sample string 1",
      "PageTemplateName": "sample string 2"
    },
    "PageTemplateAction": "sample string 8",
    "ChildPageMenus": [
      {
        "Id": "fa96d699-fc67-4e74-a4e5-f6fd288723bc",
        "Text": "sample string 2",
        "IconClass": "sample string 3",
        "Order": 4,
        "Display": 0,
        "Type": 0,
        "Hyperlink": "sample string 5",
        "OpenInNewWindow": true,
        "Pinned": true,
        "PageTemplate": {
          "PageName": "sample string 1",
          "PageTemplateName": "sample string 2"
        },
        "PageTemplateAction": "sample string 8",
        "ChildPageMenus": []
      },
      {
        "Id": "fa96d699-fc67-4e74-a4e5-f6fd288723bc",
        "Text": "sample string 2",
        "IconClass": "sample string 3",
        "Order": 4,
        "Display": 0,
        "Type": 0,
        "Hyperlink": "sample string 5",
        "OpenInNewWindow": true,
        "Pinned": true,
        "PageTemplate": {
          "PageName": "sample string 1",
          "PageTemplateName": "sample string 2"
        },
        "PageTemplateAction": "sample string 8",
        "ChildPageMenus": []
      }
    ]
  }
]

text/html

Sample: 
[{"Alignment":0,"Id":"579a38ca-1a4f-4e6a-b522-9592eca2807d","Text":"sample string 2","IconClass":"sample string 3","Order":4,"Display":0,"Type":0,"Hyperlink":"sample string 5","OpenInNewWindow":true,"Pinned":true,"PageTemplate":{"PageName":"sample string 1","PageTemplateName":"sample string 2"},"PageTemplateAction":"sample string 8","ChildPageMenus":[{"Id":"fa96d699-fc67-4e74-a4e5-f6fd288723bc","Text":"sample string 2","IconClass":"sample string 3","Order":4,"Display":0,"Type":0,"Hyperlink":"sample string 5","OpenInNewWindow":true,"Pinned":true,"PageTemplate":{"PageName":"sample string 1","PageTemplateName":"sample string 2"},"PageTemplateAction":"sample string 8","ChildPageMenus":[]},{"Id":"fa96d699-fc67-4e74-a4e5-f6fd288723bc","Text":"sample string 2","IconClass":"sample string 3","Order":4,"Display":0,"Type":0,"Hyperlink":"sample string 5","OpenInNewWindow":true,"Pinned":true,"PageTemplate":{"PageName":"sample string 1","PageTemplateName":"sample string 2"},"PageTemplateAction":"sample string 8","ChildPageMenus":[]}]},{"Alignment":0,"Id":"579a38ca-1a4f-4e6a-b522-9592eca2807d","Text":"sample string 2","IconClass":"sample string 3","Order":4,"Display":0,"Type":0,"Hyperlink":"sample string 5","OpenInNewWindow":true,"Pinned":true,"PageTemplate":{"PageName":"sample string 1","PageTemplateName":"sample string 2"},"PageTemplateAction":"sample string 8","ChildPageMenus":[{"Id":"fa96d699-fc67-4e74-a4e5-f6fd288723bc","Text":"sample string 2","IconClass":"sample string 3","Order":4,"Display":0,"Type":0,"Hyperlink":"sample string 5","OpenInNewWindow":true,"Pinned":true,"PageTemplate":{"PageName":"sample string 1","PageTemplateName":"sample string 2"},"PageTemplateAction":"sample string 8","ChildPageMenus":[]},{"Id":"fa96d699-fc67-4e74-a4e5-f6fd288723bc","Text":"sample string 2","IconClass":"sample string 3","Order":4,"Display":0,"Type":0,"Hyperlink":"sample string 5","OpenInNewWindow":true,"Pinned":true,"PageTemplate":{"PageName":"sample string 1","PageTemplateName":"sample string 2"},"PageTemplateAction":"sample string 8","ChildPageMenus":[]}]}]

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.