TaskTemplates

Introduction

TaskTemplates store what a task is and how progress is reported.

Templates can have related TaskFields that define which values are captured into TaskProgressFields.

TaskAssignments use template data to create concrete TaskExecutions.

Model Definition

Alias

taskTemplate

Relations

Relation	Key	Type	Relation Field(s)
TaskTemplate	parent	Belongs to	parent_id
TaskTemplates	children	Has many	parent_id
TaskAssignments	taskAssignments	Has many	parent_id
TaskExecutions	tasks	Has many through	tasks.task_assignment_id
TaskFields	formFields	Has many	form_fields.form_id, form_fields.form_type
User	user	Belongs to	user_id
Layouts	layouts	Has many	layouts.layoutable_type, layouts.layoutable_id

[Adm.] List

Definition

GET /api/administration/tasks-2/templates

Request Keys

No additional request keys.

Example Request

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

Example Response

[
  {
    "id": 6,
    "title": "Safety Checklist",
    "description": "<p>Describe your template</p>",
    "parent_id": null,
    "sort_number": 39,
    "user_id": 144,
    "grade_scale": null,
    "tour_enabled": true,
    "quick_assignable": false
  }
]

List quick assignable templates

Definition

GET /api/tasks-2/templates/quick-assignable

Request Keys

No additional request keys.

Example Request

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

Example Response

[
  {
    "id": 6,
    "title": "Safety Checklist",
    "quick_assignable": true
  }
]

[Adm.] Show

Definition

GET /api/administration/tasks-2/templates/{taskTemplate}

Request Keys

Key	Type	Default	Description
taskTemplate	integer	-	TaskTemplate ID.

Example Request

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

Example Response

{
  "id": 6,
  "title": "Safety Checklist",
  "description": "<p>Describe your template</p>",
  "parent_id": null,
  "sort_number": 39,
  "user_id": 144,
  "grade_scale": null,
  "tour_enabled": true,
  "quick_assignable": false
}

[Adm.] Create

Definition

POST /api/administration/tasks-2/templates

Request Keys

Key	Type	Default	Description
title*	string	-	Template title.
description	string	null	Template description.
parent_id	integer	null	Parent template ID.
lang_id	string	system language	Language key.
sort_number	integer	auto	Sort number.
grade_scale	integer	null	Grade scale.
tour_enabled	boolean	false	Enables user tour for executions from this template.
quick_assignable	boolean	false	Enables quick-assignment usage.

Keys with * are required.

Example Request

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('POST', '/api/administration/tasks-2/templates', [
    'headers' => ['Authorization' => "Bearer {accessToken}"],
    'json' => [
        'title' => 'Safety Checklist',
        'description' => '<p>Describe your template</p>',
        'quick_assignable' => true
    ]
]);

Example Response

{
  "status": "success",
  "data": {
    "id": 6,
    "title": "Safety Checklist",
    "description": "<p>Describe your template</p>",
    "parent_id": null,
    "sort_number": 39,
    "quick_assignable": true,
    "tour_enabled": false
  }
}

[Adm.] Update

Definition

PUT /api/administration/tasks-2/templates/{taskTemplate}

Request Keys

Key	Type	Default	Description
taskTemplate	integer	-	Route parameter. Template ID
title	string	-	Template title.
description	string	-	Template description.
parent_id	integer	-	Parent template ID.
lang_id	string	-	Language key.
sort_number	integer	-	Sort number.
grade_scale	integer	-	Grade scale.
tour_enabled	boolean	-	Tour-enabled flag.
quick_assignable	boolean	-	Quick-assignable flag.

Example Request

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

Example Response

{
  "status": "success",
  "data": {
    "id": 6,
    "title": "Safety Checklist (updated)",
    "quick_assignable": true
  }
}

[Adm.] Delete

Definition

DELETE /api/administration/tasks-2/templates/{taskTemplate}

Request Keys

Key	Type	Default	Description
taskTemplate	integer	-	TaskTemplate ID.

Example Request

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

Example Response

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