| Requires any of the roles: | Admin, TenantAdmin, TaskAdmin |
| PUT | /tasklist | Updates a task list. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TaskListId | body | string | Yes | TaskList ID |
| IncompleteReason | body | IncompleteReason | No | If 'Status' is set to 'Incomplete', the reason why.Allowable Values
|
| IncompleteReasonDescription | body | string | No | If 'IncompleteReason' is set to 'Other', the reason(s) why. |
| 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 | Value |
|---|---|
| ResourcesMissing | 10 |
| PrioritySwitch | 20 |
| GuestDeclined | 30 |
| FeelingUnwell | 40 |
| Other | 50 |
| 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.
PUT /tasklist HTTP/1.1
Host: api.4spaces.io
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
taskListId: 00000000000000000000000000000000,
incompleteReason: 0,
incompleteReasonDescription: String,
accessTemplateId: 00000000000000000000000000000000,
priority: 0,
start: -62135596800000,
deadline: -62135596800000,
categories:
[
10
],
recurrenceConfiguration: String,
shiftId: 00000000000000000000000000000000,
teamId: 00000000000000000000000000000000,
businessUserId: 0,
status: 0,
name: String,
instructions: String,
version: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}