| Requires any of the roles: | Admin, TenantAdmin, TaskAdmin |
| POST | /tasklists | Creates one or more task lists. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccessTemplateGroupId | body | string | No | Access Template Id. Set a value in case the TaskList is relevant to a specific smartspace. |
| SaveAsTemplate | body | boolean | No | Flag indicating if a template should be saved based on the tasklist being created. |
| Tasks | body | array | No | Tasks to create as part of the task list. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccessTemplateId | form | string | No | Access Template Id. Set a value in case the TaskList is relevant to a specific smartspace. |
| Priority | form | TaskListPriority | Yes | TaskListPriority, ranking this TaskList amid others.Allowable Values
|
| Start | form | string | No | The optional start time of the task list. |
| Deadline | form | string | No | The optional deadline of the task list. |
| Categories | form | array | No | Tags under which to categorize the tasklist. |
| RecurrenceConfiguration | form | string | No | Recurrence configuration in iCalendar format. |
| ShiftId | form | string | No | ID of a shift that this task list is linked to. If no shift is selected, a user or team must be selected. |
| TeamId | form | string | No | ID of a team that this task list is linked to. If no team is selected, a user or shift must be selected. |
| BusinessUserId | form | integer | No | ID of a business user that this task list is directly linked to. If no business user is selected, a team or shift must be selected. |
| Status | form | Status | Yes | The status/progress of the task list.Allowable Values
|
| Name | form | string | Yes | The base name for this (group of) lists. |
| 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 | Value |
|---|---|
| ToDo | 0 |
| InProgress | 10 |
| Incomplete | 30 |
| Done | 40 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | Yes | Task name. |
| Description | form | string | No | Task 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.Allowable Values
|
| Order | form | integer | No | The position of the task within its task list. |
| TaskStatus | form | TaskStatus | Yes | Current status of the task.Allowable Values
|
| TaskListId | form | string | Yes | The ID of the TaskList to which this Task belongs. |
| Name | Value |
|---|---|
| Standard | 0 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Ids | form | IEnumerable<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 .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /tasklists HTTP/1.1
Host: api.4spaces.io
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{Unable to show example output for type 'CreateTaskLists' using the custom 'csv' filter}One or more errors occurred. (Unable to cast object of type 'ServiceStack.Host.BasicResponse' to type 'ServiceStack.Host.NetCore.NetCoreResponse'.)
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{Unable to show example output for type 'TaskListsCreatedResponse' using the custom 'csv' filter}One or more errors occurred. (Unable to cast object of type 'ServiceStack.Host.BasicResponse' to type 'ServiceStack.Host.NetCore.NetCoreResponse'.)