LayoutRows

Introduction

LayoutRows represent a row in a user defined Layout. LayoutRows can consist of many LayoutColumns and are always attached to a Layout. There can not be any Element in a LayoutRow without being attached to a LayoutColumn.

Model & Relations

Namespace

Modules\Layout\Entities\LayoutRow

Relations

Relation	Key	Type	Relation Field(s)
Layout	layout	Belongs to	layout_id
LayoutColumns	layoutColumns	Has many	layout_columns.layout_row_id

Traits

• Sortable
• SoftDeletes

List

Get a list of all LayoutRows available in the system.

Definition

GET /api/layouts/rows

Example Request

PHP

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

Example Response

[
  {
    "id": 2,
    "title": null,
    "layout_id": 1,
    "separator": false,
    "sort_number": 3,
    "created_at": "2021-10-25 19:07:59",
    "updated_at": "2021-10-25 19:07:59",
    "deleted_at": null
  },
  {
    "id": 3,
    "title": null,
    "layout_id": 2,
    "separator": false,
    "sort_number": 1,
    "created_at": "2021-10-26 15:00:21",
    "updated_at": "2021-10-26 15:00:21",
    "deleted_at": null
  },
  {
    "id": 4,
    "title": null,
    "layout_id": 2,
    "separator": false,
    "sort_number": 3,
    "created_at": "2021-10-26 15:00:21",
    "updated_at": "2021-10-26 15:00:21",
    "deleted_at": null
  }
]

Get

Get a single LayoutRow by id.

Definition

GET /api/layouts/rows/{id}

Example Request

PHP

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

Example Response

{
  "id": 2,
  "title": null,
  "layout_id": 1,
  "separator": false,
  "sort_number": 3,
  "created_at": "2021-10-25 19:07:59",
  "updated_at": "2021-10-25 19:07:59",
  "deleted_at": null
}

Create

Creates a new LayoutRow

Definition

POST /api/layouts/rows

Request Keys

Key	Type	Default	Description
title	string	null	The title for the LayoutRow
layout_id*	integer	-	The Layout this LayoutRow belongs to
seperator	boolean	false	Whether there should be a seperator displayed or not
sort_number	integer	Current highest +1	The index of the LayoutRow related to the Layout

Keys with * are required.
Keys with ** are normalized to the information given by the route.

---

Example Request

PHP

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('POST', '/api/layouts/rows', [
    'headers' => ['Authorization' => "Bearer {accessToken}"],
    'json' => [
        'title' => null,
        'layout_id' => '1',
        'seperator' => 'false',
        'sort_number' => '1',
    ]
]);

Example Response

{
  "status": "success",
  "data": {
    "id": 1,
    "title": null,
    "layout_id": 1,
    "separator": false,
    "sort_number": 1,
    "created_at": "2023-04-28 13:55:21",
    "updated_at": "2023-04-28 13:55:21",
    "deleted_at": null
  }
}

Update

Update an existing LayoutRow by id.

Definition

PUT /api/layouts/rows/{id}

Request Keys

Key	Type	Default	Description
title	string	-	The title for the LayoutRow
layout_id	integer	-	The Layout this LayoutRow belongs to
seperator	boolean	-	Whether there should be a seperator displayed or not
sort_number	integer	-	The index of the LayoutRow related to the Layout

Keys with * are required.
Keys with ** are normalized to the information given by the route.

Example Request

PHP

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

Example Response

{
  "status": "success",
  "data": {
    "id": 1,
    "title": null,
    "layout_id": 1,
    "separator": true,
    "sort_number": 1,
    "created_at": "2023-04-28 13:55:21",
    "updated_at": "2023-04-28 13:57:40",
    "deleted_at": null
  }
}

Delete

Delete an existing Layout by id.

Definition

DELETE /api/layouts/rows/{id}

Example Request

PHP

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

Example Response

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