TaskTemplateCompositions

Introduction

TaskTemplateCompositions combine multiple TaskTemplates. A TaskAssignment can use a composition to create one execution for each included template.

The description field uses the shared Rich Text HTML format.

Compositions can store Tags permitted by the tasks tag section. These tags are independent of the tags on their templates and assignments.

Model Definition

Alias

taskTemplateComposition

Capabilities

• Entity Permissions - Direct grants can allow permitted users to view, update, or delete a composition in administration.

• Translations - The title and description fields are translatable.

Admin: List

List all accessible compositions, including soft-deleted records.

Definition

GET /api/administration/tasks-2/templates/compositions

Example Request

PHP

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

Example Response

[
  {
    "id": 12,
    "user_id": 3,
    "lang_id": "en-US",
    "folder_id": null,
    "title": "Opening Checklist",
    "description": "<p>Complete both opening tasks.</p>",
    "sort_number": 1,
    "deleted_at": null
  },
  {
    "id": 13,
    "user_id": 4,
    "lang_id": "en-US",
    "folder_id": 8,
    "title": "Closing Checklist",
    "description": "<p>Finish the closing and security tasks.</p>",
    "sort_number": 2,
    "deleted_at": null
  }
]

Admin: Show

Show one composition, including a soft-deleted record.

Definition

GET /api/administration/tasks-2/templates/compositions/{taskTemplateComposition}

Route Parameters

Parameter	Type	Description
taskTemplateComposition	integer	Composition ID.

Example Request

PHP

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

Example Response

{
  "id": 12,
  "user_id": 3,
  "lang_id": "en-US",
  "folder_id": null,
  "title": "Opening Checklist",
  "description": "<p>Complete both opening tasks.</p>",
  "sort_number": 1,
  "deleted_at": null
}

Admin: Create

Create a composition and optionally attach templates.

Definition

POST /api/administration/tasks-2/templates/compositions

Request Keys

Key	Type	Default	Description
lang_id	string	System language	Language key. Use en-US for this example.
folder_id	integer | null	null	Related Folder ID.
title*	string	-	Composition title.
description	string | null	null	HTML description.
sort_number	integer	Auto	Position within the folder.
task_template_ids	integer[]	[]	Templates to attach.
entity_permissions	object[]	[]	Direct Entity Permissions.
tag_ids	array	No tags	IDs of tags to attach.

Keys with * are required.

Behavior

• user_id is set to the authenticated user; a request-body value cannot select another owner.

• Supplying task_template_ids synchronizes the composition's template relations.

• Tag IDs outside the tasks section's allowed set are ignored.

Example Request

PHP

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('POST', '/api/administration/tasks-2/templates/compositions', [
    'headers' => ['Authorization' => "Bearer {accessToken}"],
    'json' => [
        'lang_id' => 'en-US',
        'title' => 'Opening Checklist',
        'description' => '<p>Complete both opening tasks.</p>',
        'sort_number' => 1,
        'task_template_ids' => [21, 22]
    ]
]);

Example Response

{
  "status": "success",
  "data": {
    "id": 12,
    "user_id": 3,
    "lang_id": "en-US",
    "folder_id": null,
    "title": "Opening Checklist",
    "description": "<p>Complete both opening tasks.</p>",
    "sort_number": 1
  }
}

Admin: Update

Update a composition and optionally replace its attached templates.

Definition

PUT /api/administration/tasks-2/templates/compositions/{taskTemplateComposition}

Route Parameters

Parameter	Type	Description
taskTemplateComposition	integer	Composition ID.

Request Keys

Key	Type	Description
lang_id	string	Language key.
folder_id	integer | null	Related folder ID, or null.
title	string	Composition title.
description	string | null	HTML description.
sort_number	integer	Position within the folder.
task_template_ids	integer[]	Complete replacement set; an empty array detaches all templates.
entity_permissions	object[]	Direct Entity Permissions.
tag_ids	array	Replacement set of tag IDs; an empty array removes all tags.

Behavior

• user_id is replaced with the authenticated user.

• task_template_ids is synchronized only when the key is present.

• Tags change only when tag_ids is supplied. IDs outside the tasks section's allowed set are ignored.

Example Request

PHP

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('PUT', '/api/administration/tasks-2/templates/compositions/12', [
    'headers' => ['Authorization' => "Bearer {accessToken}"],
    'json' => [
        'title' => 'Opening and Safety Checklist',
        'task_template_ids' => [21, 22, 23]
    ]
]);

Example Response

{
  "status": "success",
  "data": {
    "id": 12,
    "user_id": 3,
    "lang_id": "en-US",
    "folder_id": null,
    "title": "Opening and Safety Checklist",
    "description": "<p>Complete both opening tasks.</p>",
    "sort_number": 1
  }
}

Admin: Delete

Soft-delete a composition.

Definition

DELETE /api/administration/tasks-2/templates/compositions/{taskTemplateComposition}

Route Parameters

Parameter	Type	Description
taskTemplateComposition	integer	Composition ID.

Example Request

PHP

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('DELETE', '/api/administration/tasks-2/templates/compositions/12', [
    'headers' => ['Authorization' => "Bearer {accessToken}"]
]);

Example Response

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