GET v1/application/column-layout/{id}
Use this method to obtain details for the provided column layout id.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Column Layout Unique Identifier. |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
Returns a column layout if found, otherwise returns an HTTP response header with a message regarding the reason why, the API did not yield the expected result.
ColumnLayout| Name | Description | Type | Additional 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
{
"id": "sample string 1",
"name": "sample string 2",
"columns": 3,
"widths": [
1.1,
2.1
]
}