Viviot.Api

<back to all web services

GetTask

Requires Authentication
Requires any of the roles:Admin, TenantAdmin, TaskAdmin
The following routes are available for this service:
GET/tasklist/taskGets a task in a task list.
CommonTask Parameters:
NameParameterData TypeRequiredDescription
TaskIdformstringYesTask ID
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
TaskResponse Parameters:
NameParameterData TypeRequiredDescription
DataformTaskViewNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
TaskView Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
NameformstringNo
DescriptionformstringNo
CompleteWithTagformboolNo
NfcCodeformstringNo
TaskTypeformTaskTypeNo
Orderformlong?No
TaskStatusformStatusNo
TaskListIdformGuidNo
TaskType Enum:
NameValue
Standard0
Status Enum:
NameValue
ToDo0
InProgress10
Incomplete30
Done40

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /tasklist/task HTTP/1.1 
Host: api.4spaces.io 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"data":{"id":"00000000000000000000000000000000","name":"String","description":"String","completeWithTag":false,"nfcCode":"String","taskType":0,"order":0,"taskStatus":0,"taskListId":"00000000000000000000000000000000"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}