| Requires any of the roles: | Admin, TenantAdmin, TaskAdmin |
| POST | /tasklist/template | Creates a task list template. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TaskTemplates | body | array | No | Task templates to create as part of the task list template. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Priority | form | TaskListPriority | Yes | TaskListPriority, ranking this tasklist template amid others.Allowable Values
|
| Name | form | string | Yes | The list template's name. |
| Categories | form | array | No | Tags under which to categorize the tasklist. |
| AccessTemplateId | form | string | No | Access template ID. |
| Instructions | form | string | No | Instructions on how to complete the task list. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Version | form | integer | No | Api version |
| Name | Value |
|---|---|
| None | 0 |
| VeryLow | 10 |
| Low | 20 |
| Medium | 30 |
| High | 40 |
| VeryHigh | 50 |
| Critical | 60 |
| Name | Value |
|---|---|
| Cleaning | 10 |
| Maintenance | 20 |
| Disinfection | 30 |
| Inspection | 40 |
| Security | 50 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | Yes | Task template name. |
| Description | form | string | No | Task template description. |
| CompleteWithTag | form | boolean | Yes | Flag indicating whether the task completion must be marked by scanning a NFC tag. |
| NfcCode | form | string | No | NFC code of the tag. |
| TaskType | form | TaskType | Yes | The type of task template.Allowable Values
|
| Order | form | integer | No | The position of the task template within its task list template. |
| TaskListTemplateId | form | string | Yes | The ID of the tasklist template to which this task template belongs. |
| Name | Value |
|---|---|
| Standard | 0 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /tasklist/template HTTP/1.1
Host: api.4spaces.io
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
taskTemplates:
[
{
name: String,
description: String,
completeWithTag: False,
nfcCode: String,
taskType: 0,
order: 0,
taskListTemplateId: 00000000000000000000000000000000,
version: 0
}
],
priority: 0,
name: String,
categories:
[
10
],
accessTemplateId: 00000000000000000000000000000000,
instructions: String,
version: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
id: 00000000000000000000000000000000,
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}