PUT v1/application/column-layout/{id}

Use this method to update fields of an existing column layout.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Column Layout Unique Identifier

string

Required

Body Parameters

Layout information to be updated.

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.

Request Formats

application/json, text/json

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

Response Information

Resource Description

Returns HTTP status code OK (200) there were no errors, in the body of the response we return true/false where true will mean something was updated, and false if no information qualified or differed from the existing information.

boolean

Response Formats

application/json, text/json

Sample:
true