POST v1/pages/{environment}/{orgId}/{appId}?layer={layer}
Use this method to create a new dynamic content page. Required page properties are, page title, and column layout. All other properties are optional within the page structure. When creating a page, if Public lobby or Private lobby are set to true, the application will be updated to select the created page as the new lobby page. Note that this does not happen when the page is updated, as different separate methods must be used to mark a page as the public or private facing lobby for an application. When creating a page you have the option to create a page category on the fly by filling the category display text only. If there is a category with the exact same name we avoid duplicates and use the existing category UUID instead, but if not, a new category will be created.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| environment |
Environment where the org originated from. |
string |
Required |
| orgId |
Organization Id |
integer |
Required |
| appId |
Application Id |
integer |
Required |
| layer |
Optional URI Venue UUID if the destination of this page is a nested content layer and not the organization itself. |
string |
None. |
Body Parameters
Required page structure to be created.
DynamicPage| Name | Description | Type | Additional information |
|---|---|---|---|
| message |
Use this property to control the message shown to the user when a form is successfully submitted to the web service. |
string |
None. |
| error |
Use this property to control the message shown to the user when an error occur when submitting a form. |
string |
None. |
| formId |
Use this property to specify the form template UUID the page is associated with. |
string |
None. |
| id |
Dynamic Page Unique Identifier. |
string |
None. |
| title |
Use this property to set the display title of a dynamic page. |
string |
None. |
| disabled |
This property is used to disable a page from been published. |
boolean |
None. |
| columns |
Page column layout |
ColumnLayout |
None. |
| category |
Category associated to a page. |
PageCategory |
None. |
| privateLobby |
Use this property to specify that this page is meant to be the lobby or home page while in the private (authenticated) section of the application. |
boolean |
None. |
| publicLobby |
Use this property to mark this page as the Home page or Lobby for an application. |
boolean |
None. |
| content | Collection of ContentItem |
None. |
|
| bkColor |
Use this property to specify the background color of a page. The format should be an comma delimited rgba value all elements within 0-1 range. for example: 1,1,1,1 The example above would specify the color white. |
string |
None. |
| properties |
Use this property to store additional UI View information. Examples of values been stored as page properties are background Image, Page Inserts (Margin) and much more. |
Collection of ContentSetting |
None. |
Request Formats
application/json, text/json
[
{
"message": "sample success message",
"error": "sample error message",
"title": "Sample Title",
"disabled": false,
"columns": {
"id": "9310d02a-8b4a-45e9-805d-02fd23fb4fbf",
"name": "1Column",
"columns": 1
},
"category": {
"id": "63b14fa2-4396-483b-a2f0-9d9606968f31",
"text": "Default Cat",
"default": false
},
"privateLobby": false,
"publicLobby": true,
"bkColor": "0,0,0,0",
"properties": [
{
"id": "530b4238-0450-488c-98f6-3cbc2d0eaa24",
"name": "HasNavbar",
"value": "0"
},
{
"id": "68720d8d-5142-40be-bdd9-6e193f30c737",
"name": "ContentSpacing",
"value": "0"
},
{
"id": "81119089-7aa8-4745-8137-05b619bbafe3",
"name": "DefaultRightTray",
"value": "0"
},
{
"id": "be77c299-2d40-4cae-aa6d-f6a9ec1b41c4",
"name": "Background_Image",
"value": ""
},
{
"id": "cc7124b8-0776-4a30-982a-f6d8fab79991",
"name": "PageInsets",
"value": "0,0,0,0"
},
{
"id": "d3463aba-464b-4012-88e8-59c543623418",
"name": "DefaultLeftTray",
"value": "0"
},
{
"id": "e84c90be-d1d3-4ee9-a914-482b00c059c4",
"name": "HasToolbar",
"value": "0"
}
]
}
]
Response Information
Resource Description
Returns a structure with details about the created page or appropriate response headers describing what happen.
DynamicPage| Name | Description | Type | Additional information |
|---|---|---|---|
| message |
Use this property to control the message shown to the user when a form is successfully submitted to the web service. |
string |
None. |
| error |
Use this property to control the message shown to the user when an error occur when submitting a form. |
string |
None. |
| formId |
Use this property to specify the form template UUID the page is associated with. |
string |
None. |
| id |
Dynamic Page Unique Identifier. |
string |
None. |
| title |
Use this property to set the display title of a dynamic page. |
string |
None. |
| disabled |
This property is used to disable a page from been published. |
boolean |
None. |
| columns |
Page column layout |
ColumnLayout |
None. |
| category |
Category associated to a page. |
PageCategory |
None. |
| privateLobby |
Use this property to specify that this page is meant to be the lobby or home page while in the private (authenticated) section of the application. |
boolean |
None. |
| publicLobby |
Use this property to mark this page as the Home page or Lobby for an application. |
boolean |
None. |
| content | Collection of ContentItem |
None. |
|
| bkColor |
Use this property to specify the background color of a page. The format should be an comma delimited rgba value all elements within 0-1 range. for example: 1,1,1,1 The example above would specify the color white. |
string |
None. |
| properties |
Use this property to store additional UI View information. Examples of values been stored as page properties are background Image, Page Inserts (Margin) and much more. |
Collection of ContentSetting |
None. |
Response Formats
application/json, text/json
[
{
"id": "5554dceb-8066-4ba5-9a88-ba43198865aa",
"message": "sample success message",
"error": "sample error message",
"title": "Sample Title",
"disabled": false,
"columns": {
"id": "9310d02a-8b4a-45e9-805d-02fd23fb4fbf",
"name": "1Column",
"columns": 1
},
"category": {
"id": "63b14fa2-4396-483b-a2f0-9d9606968f31",
"text": "Default Cat",
"default": false
},
"privateLobby": false,
"publicLobby": true,
"bkColor": "0,0,0,0",
"properties": [
{
"id": "530b4238-0450-488c-98f6-3cbc2d0eaa24",
"name": "HasNavbar",
"value": "0"
},
{
"id": "68720d8d-5142-40be-bdd9-6e193f30c737",
"name": "ContentSpacing",
"value": "0"
},
{
"id": "81119089-7aa8-4745-8137-05b619bbafe3",
"name": "DefaultRightTray",
"value": "0"
},
{
"id": "be77c299-2d40-4cae-aa6d-f6a9ec1b41c4",
"name": "Background_Image",
"value": ""
},
{
"id": "cc7124b8-0776-4a30-982a-f6d8fab79991",
"name": "PageInsets",
"value": "0,0,0,0"
},
{
"id": "d3463aba-464b-4012-88e8-59c543623418",
"name": "DefaultLeftTray",
"value": "0"
},
{
"id": "e84c90be-d1d3-4ee9-a914-482b00c059c4",
"name": "HasToolbar",
"value": "0"
}
]
}
]