Viviot.Api

<back to all web services

UpdateTask

Requires Authentication
Requires any of the roles:Admin, TenantAdmin, TaskAdmin
The following routes are available for this service:
PUT/tasklist/taskUpdates a task in a task list.
UpdateTask Parameters:
NameParameterData TypeRequiredDescription
TaskIdbodystringYesTask ID
CommonBaseTask Parameters:
NameParameterData TypeRequiredDescription
NameformstringYesTask name.
DescriptionformstringNoTask description.
CompleteWithTagformbooleanYesFlag indicating whether the task completion must be marked by scanning a NFC tag.
NfcCodeformstringNoNFC code of the tag.
TaskTypeformTaskTypeYesThe type of task.

Allowable Values

  • Standard
OrderformintegerNoThe position of the task within its task list.
TaskStatusformTaskStatusYesCurrent status of the task.

Allowable Values

  • ToDo
  • InProgress
  • Incomplete
  • Done
TaskListIdformstringYesThe ID of the TaskList to which this Task belongs.
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
TaskType Enum:
NameValue
Standard0
Status Enum:
NameValue
ToDo0
InProgress10
Incomplete30
Done40
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

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.

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

{"taskId":"00000000000000000000000000000000","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/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}