GET v1/application/{environment}/{orgId}/{appId}/column-layout

Use this method to get a list of column layouts available for the provided application id.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
environment

Environment where the org originated from.

 string

Required
orgId

Organization Id

 integer

Required
appId

Application Id

 integer

Required

Body Parameters

None.

Response Information

Resource Description

Returns a collection of column layouts.

Collection of ColumnLayout
NameDescriptionTypeAdditional information
id

Column Layout unique identifier.

 string

None.
name

Column layout display name.

 string

None.
columns

Number of columns to vertically device the page button placement.

 integer

None.
widths

By default widths are one hundred percent divided by the amount of columns, and the app framework knows to partition the UI based on this rule. However, a page may define its own width partition by declaring a width for each column where values in the range of zero and one, represent percentages, and grater than one are actual pixels (Custom app implementations can at anytime define pixels to be anything else, points for example, but that is custom to the application).

 Collection of decimal number

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "id": "sample string 1",
    "name": "sample string 2",
    "columns": 3,
    "widths": [
      1.1,
      2.1
    ]
  },
  {
    "id": "sample string 1",
    "name": "sample string 2",
    "columns": 3,
    "widths": [
      1.1,
      2.1
    ]
  }
]