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
Name | Description | Type | Additional information |
---|---|---|---|
name |
Page name. |
string |
Required |
share |
Optional share identifier. |
globally unique identifier |
None. |
Body Parameters
None.
Response Information
Resource Description
Page definition.
PageResponseName | Description | Type | Additional 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": "a2e78432-c87c-4f68-af3c-c26e32af5e39", "Name": "sample string 2", "PluralName": "sample string 3", "Views": [ { "TemplateId": "6c64423f-9f48-4135-b719-72501b2015f7", "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": "6c64423f-9f48-4135-b719-72501b2015f7", "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":"a2e78432-c87c-4f68-af3c-c26e32af5e39","Name":"sample string 2","PluralName":"sample string 3","Views":[{"TemplateId":"6c64423f-9f48-4135-b719-72501b2015f7","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":"6c64423f-9f48-4135-b719-72501b2015f7","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>a2e78432-c87c-4f68-af3c-c26e32af5e39</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>6c64423f-9f48-4135-b719-72501b2015f7</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>6c64423f-9f48-4135-b719-72501b2015f7</TemplateId> </PageTemplateResponse> </Views> </PageResponse>