| Requires any of the roles: | Admin, TenantAdmin, TaskAdmin |
| POST | /tasklist/task | Creates a task in a task list. |
|---|
| 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 | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Version | form | integer | No | Api version |
| Name | Value |
|---|---|
| Standard | 0 |
| Name | Value |
|---|---|
| ToDo | 0 |
| InProgress | 10 |
| Incomplete | 30 |
| Done | 40 |
| 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/task HTTP/1.1
Host: api.4spaces.io
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
name: String,
description: String,
completeWithTag: False,
nfcCode: String,
taskType: 0,
order: 0,
taskStatus: 0,
taskListId: 00000000000000000000000000000000,
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
}
}
}