LayoutColumns

Introduction

LayoutColumns divide a LayoutRow horizontally and receive layout elements.

Model Definition

Alias

layoutColumn

Capabilities

• Translations - Localizes title; examples use en-US.

Relations

Key	Relation	Type	Relation Field(s)
layoutRow	LayoutRow	Belongs to	layout_row_id
layoutableElements	LayoutColumnLayoutElements	Has many	layout_column_layout_elements.layout_column_id
formFields	FormFields	Morph to many	layout_column_layout_element

List

List LayoutColumns.

Definition

GET /api/layouts/columns

Request Keys

Key	Type	Default	Description
selects	string	All fields	Comma-separated fields to return.
relations	string	Default relations	Pipe-separated relations to include.
limit	integer	No limit	Maximum number of records.

Example Request

PHP

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('GET', '/api/layouts/columns', [
    'headers' => ['Authorization' => "Bearer {accessToken}"]
]);

Example Response

[
  {
    "id": 71,
    "title": "Contact details",
    "width": 8,
    "layout_row_id": 61,
    "lang_id": "en-US",
    "top_separator": false,
    "right_separator": true,
    "bottom_separator": false,
    "left_separator": false,
    "sort_number": 1
  },
  {
    "id": 72,
    "title": "Owner",
    "width": 4,
    "layout_row_id": 61,
    "lang_id": "en-US",
    "top_separator": false,
    "right_separator": false,
    "bottom_separator": false,
    "left_separator": true,
    "sort_number": 2
  }
]

Show

Show one LayoutColumn.

Definition

GET /api/layouts/columns/{layoutColumn}

Route Parameters

Parameter	Type	Description
layoutColumn	integer	LayoutColumn ID.

Request Keys

Key	Type	Default	Description
selects	string	All fields	Comma-separated fields to return.
relations	string	Default relations	Pipe-separated relations to include.

Example Request

PHP

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('GET', '/api/layouts/columns/71', [
    'headers' => ['Authorization' => "Bearer {accessToken}"]
]);

Example Response

{
  "id": 71,
  "title": "Contact details",
  "width": 8,
  "layout_row_id": 61,
  "lang_id": "en-US",
  "top_separator": false,
  "right_separator": true,
  "bottom_separator": false,
  "left_separator": false,
  "sort_number": 1
}

Create

Create a new LayoutColumn.

Definition

POST /api/layouts/columns

Request Keys

Key	Type	Default	Description
title	string | null	null	Column label.
layout_row_id*	integer	-	Parent LayoutRow ID.
lang_id	string	System language	Language key. Use en-US for this example.
width	integer	Available width	Column width validated against the other columns in the row.
sort_number	integer	Auto	Order within the row.

Keys with * are required.

Example Request

PHP

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('POST', '/api/layouts/columns', [
    'headers' => ['Authorization' => "Bearer {accessToken}"],
    'json' => [
        'title' => 'Owner',
        'layout_row_id' => 61,
        'lang_id' => 'en-US',
        'width' => 4,
        'sort_number' => 2
    ]
]);

Example Response

{
  "status": "success",
  "data": {
    "id": 72,
    "title": "Owner",
    "width": 4,
    "layout_row_id": 61,
    "lang_id": "en-US",
    "top_separator": false,
    "right_separator": false,
    "bottom_separator": false,
    "left_separator": true,
    "sort_number": 2
  }
}

Update

Update an existing LayoutColumn.

Definition

PUT /api/layouts/columns/{layoutColumn}

Route Parameters

Parameter	Type	Description
layoutColumn	integer	Column ID.

Request Keys

Key	Type	Default	Description
title	string | null	Current value	Column label.
layout_row_id	integer	Current value	Parent LayoutRow ID.
lang_id	string	Current value	Language key.
width	integer	Current value	Width validated against the row's remaining columns.
sort_number	integer	Current value	Order within the row.

Example Request

PHP

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('PUT', '/api/layouts/columns/72', [
    'headers' => ['Authorization' => "Bearer {accessToken}"],
    'json' => [
        'title' => 'Responsible person',
        'lang_id' => 'en-US',
        'width' => 4,
        'sort_number' => 2
    ]
]);

Example Response

{
  "status": "success",
  "data": {
    "id": 72,
    "title": "Responsible person",
    "width": 4,
    "layout_row_id": 61,
    "lang_id": "en-US",
    "top_separator": false,
    "right_separator": false,
    "bottom_separator": false,
    "left_separator": true,
    "sort_number": 2
  }
}

Delete

Delete an existing LayoutColumn.

Definition

DELETE /api/layouts/columns/{layoutColumn}

Route Parameters

Parameter	Type	Description
layoutColumn	integer	LayoutColumn ID.

Example Request

PHP

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('DELETE', '/api/layouts/columns/72', [
    'headers' => ['Authorization' => "Bearer {accessToken}"]
]);

Example Response

{
  "status": "success",
  "data": null
}