TaggableSections

Introduction

TaggableSections define the different areas or modules in the system where tags can be assigned and managed. They are used to restrict, group, or organize tags for specific use cases.

A TaggableSection can have restrictions on which Tags or TagGroups are allowed, and can define a default TagGroup to use when creating Tags for that section.

Model Definition

Alias

taggableSection

Relations

Key	Relation	Type	Relation Field(s)
defaultTagGroup	TagGroup	Belongs to	default_tag_group_id
restrictedTags	Tag	Morph to many	taggable_section_restrictbale.restrictable_type, taggable_section_restrictbale.restrictable_id
restrictedTagGroups	TagGroup	Morph to many	taggable_section_restrictbale.restrictable_type, taggable_section_restrictbale.restrictable_id

Available Sections

• departments - The allowed Tags for Departments.

• infoboard - The allowed Tags for InfoboardPosts.

• manual - The allowed Tags for ManualChapters and ManualEntries.

• roles - The allowed Tags for Roles.

List

List available TaggableSections.

Definition

GET /api/tags/sections

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/tags/sections', [
    'headers' => ['Authorization' => "Bearer {accessToken}"]
]);

Example Response

[
  {
    "id": "departments",
    "allow_all": true,
    "default_tag_group_id": null,
    "created_at": "2019-06-15 12:00:00",
    "updated_at": "2019-06-15 12:00:00"
  },
  {
    "id": "infoboard",
    "allow_all": false,
    "default_tag_group_id": 31,
    "created_at": "2019-06-15 12:00:00",
    "updated_at": "2019-06-15 12:00:00"
  }
]

Show

Show one available TaggableSection.

Definition

GET /api/tags/sections/{taggableSection}

Route Parameters

Parameter	Type	Description
taggableSection	string	TaggableSection 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/tags/sections/infoboard', [
    'headers' => ['Authorization' => "Bearer {accessToken}"]
]);

Example Response

{
  "id": "infoboard",
  "allow_all": true,
  "default_tag_group_id": null,
  "created_at": "2019-06-15 12:00:00",
  "updated_at": "2019-06-15 12:00:00"
}

Admin: List

List all TaggableSections in administration scope.

Definition

GET /api/administration/tags/sections

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/administration/tags/sections', [
    'headers' => ['Authorization' => "Bearer {accessToken}"]
]);

Example Response

[
  {
    "id": "departments",
    "allow_all": true,
    "default_tag_group_id": null,
    "created_at": "2019-06-15 12:00:00",
    "updated_at": "2019-06-15 12:00:00"
  },
  {
    "id": "infoboard",
    "allow_all": false,
    "default_tag_group_id": 31,
    "created_at": "2019-06-15 12:00:00",
    "updated_at": "2019-06-15 12:00:00"
  }
]

Admin: Show

Show one TaggableSection in administration scope.

Definition

GET /api/administration/tags/sections/{taggableSection}

Route Parameters

Parameter	Type	Description
taggableSection	string	TaggableSection 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/administration/tags/sections/departments', [
    'headers' => ['Authorization' => "Bearer {accessToken}"]
]);

Example Response

{
  "id": "departments",
  "allow_all": true,
  "default_tag_group_id": null,
  "created_at": "2019-06-15 12:00:00",
  "updated_at": "2019-06-15 12:00:00"
}

Admin: Update

Update a TaggableSection by id.

Definition

PUT /api/administration/tags/sections/{taggableSection}

Route Parameters

Parameter	Type	Description
taggableSection	string	TaggableSection ID.

Request Keys

Key	Type	Default	Description
allow_all	boolean	Current value	Whether all Tags are allowed.
default_tag_group_id	integer | null	Current value	Default TagGroup ID.
restricted_tag_ids	array	Current restrictions	Allowed Tag IDs when allow_all is false.
restricted_tag_group_ids	array	Current restrictions	Objects with TagGroup id and optional recursive.

Example Request

PHP

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('PUT', '/api/administration/tags/sections/infoboard', [
    'headers' => ['Authorization' => "Bearer {accessToken}"],
    'json' => [
        'allow_all' => false,
        'default_tag_group_id' => 31,
        'restricted_tag_ids' => [21, 22],
        'restricted_tag_group_ids' => [
            ['id' => 31, 'recursive' => true]
        ]
    ]
]);

Example Response

{
  "status": "success",
  "data": {
    "id": "infoboard",
    "allow_all": false,
    "default_tag_group_id": 31,
    "created_at": "2019-06-15 12:00:00",
    "updated_at": "2019-06-15 12:30:00"
  }
}