Filter Failed Tasks

Testing

tracker - local

http://localhost:8081/

POST

api/users/v1/trackers/{trackerId}/instances/{instanceId}/tasks/filter

Request

Path Params

trackerId

string

required

instanceId

string

required

Header Params

Authorization

string

optional

Body Params application/json

ids

array[string]

optional

types

array[string]

optional

statuses

array[string]

optional

status of the tasks - UNREAD: task is not read by patient, which is gonna be displayed on PWA - READ: when patient confirms that this task has been read, its status is transfered to READ - PAUSED: when a task is waiting for patient to record their symptom, submit their questionnaire or a timer counts down. Its would be PAUSED - COMPLETED: when a task finishes its count down or patient has been recorded their information for that task - CLOSED: a task to notify client that this tracker instance has been closed

updatedBy

array[string]

optional

createdBy

array[string]

optional

limit

integer

required

offset

integer

required

sort

string

required

Example

{
    "ids": [
        "string"
    ],
    "types": [
        "string"
    ],
    "statuses": [
        "string"
    ],
    "updatedBy": [
        "string"
    ],
    "createdBy": [
        "string"
    ],
    "limit": 0,
    "offset": 0,
    "sort": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://localhost:8081/api/users/v1/trackers//instances//tasks/filter' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "ids": [
        "string"
    ],
    "types": [
        "string"
    ],
    "statuses": [
        "string"
    ],
    "updatedBy": [
        "string"
    ],
    "createdBy": [
        "string"
    ],
    "limit": 0,
    "offset": 0,
    "sort": "string"
}'

Responses

🟢200OK

application/json

Body

data

object

required

tasks

array [object {9}]

required

Example

{
    "data": {
        "tasks": [
            {
                "id": "string",
                "type": "SYMPTOM_RECORDER",
                "status": "UNREAD",
                "input": {},
                "output": {},
                "createdAt": "2023-12-23 12:05:00",
                "updatedAt": "2023-12-23 15:05:00",
                "createdBy": "string",
                "updatedBy": "string"
            }
        ]
    }
}

Modified at 2024-03-23 16:12:39

Filter tasks

Read Multi Task