GET page/menu
Gets the main menu.
Request Information
URI
https://ofd-api.blueprintcpq.net/page/menu?share={share}
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
share | globally unique identifier |
None. |
Body Parameters
None.
Response Information
Resource Description
The menu.
Collection of PageMenuName | Description | Type | Additional information |
---|---|---|---|
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:
[ { "Id": "4f462b3a-d211-4873-8f4a-64fbc926a914", "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": "4f462b3a-d211-4873-8f4a-64fbc926a914", "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:
[{"Id":"4f462b3a-d211-4873-8f4a-64fbc926a914","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":"4f462b3a-d211-4873-8f4a-64fbc926a914","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.