GET task details
Parameters
GROUP_UUID |
(string) The unique identifier for a group. |
TASK_UUID |
(string) The unique identifier for a task. |
Curl example
curl -X GET \
'https://API_HOSTNAME/api/v1/groups/GROUP_UUID/tasks/TASK_UUID' \
--header 'Authorization: Bearer BEARER_TOKEN'
Response
Task, including properties and measurements associated to the task.
Response body
{
"uuid": "TASK_UUID",
"href": "/api/v1/groups/GROUP_UUID/tasks/TASK_UUID",
"activityUuid": "ACTIVITY_UUID",
"group": {
"href": "/api/v1/groups/GROUP_UUID",
"title": "My Group"
},
"member": {
"href": "/api/v1/groups/GROUP_UUID/members/USER_UUID",
"title": "John Doe"
},
"startTime": "2019-05-20T11:00:00Z",
"endTime": "2019-05-21T03:00:00Z",
"adHoc": false,
"status": "completed",
"type": "takeSurvey",
"progress": 1.0,
"finishTime": "2019-05-20T15:13:38.515Z",
"title": "Survey Title",
"taskDate": "2019-05-20",
"measurements": [
{
"startTime": "2019-05-20T15:13:38.515Z",
"endTime": "2019-05-20T15:13:38.515Z",
"type": "surveyAnswer",
"member": {
"href": "/api/v1/groups/GROUP_UUID/members/USER_UUID",
"title": "John Doe"
},
"sourceName": "Pattern Survey UI",
"json": true,
"surveyQuestionId": "question_id_1",
"survey": {
"href": "/api/v1/groups/GROUP_UUID/surveys/SURVEY_UUID",
"title": "Survey Title"
},
"taskUuid": "TASK_UUID"
},
...
]
}
Result attributes
uuid |
(string) A unique identifier for the task. |
href |
(string) A URL fragment that can be used to retrieve details about the specific task. |
activityUuid |
(string) A unique identifier for the activity that generated the task. |
group |
(link) A reference to the group of the member. |
member |
(link) A reference to the group member. |
startTime |
(timestamp) The scheduled start time for the task. |
endTime |
(timestamp) The scheduled end time for the task. |
adHoc |
(boolean) False if the task was scheduled and generated by an activity. True if the user performed an extra ad hoc action. |
status |
(string) The status of the task. Possible values are notStarted, inProgress, failed, completed, refused, expired |
type |
(string) The task type. Possible values are |
progress |
(number) The progress of the task, expressed as a number between 0.0 and 1.0, inclusive. |
finishTime |
(timestamp) The moment that the group member actually completed the task. |
title |
(string) The title of the task. |
taskDate |
(date) The date on which the task was intended to be performed. |
measurements |
(list) Measurements associated to the task. |