Get All Tasks

Get All Tasks

This API retrieves all the tasks and also provides ability to filter tasks based on filter criteria.

Request
URI
GET
https://{api_host}/tcsa.host.com/tcsa/api/v1/tasks
COPY
Query Parameters
string
type
Optional

type of tasks user wants to retreive

Possible values are : NOTIFICATION, REMEDIATION,
integer
limit
Optional

Requested number of resources to be provided in response

integer
offset
Optional

Requested index for start of resources to be provided in response

string
time_range
Optional

Get data for last {time_range}. The format for time range is "last-{the int number}-{min/hour/days/week/month}"

time_range example 
last-5-min
string
status
Optional

filters the response based on status type

Possible values are : IN_PROGRESS, COMPLETED, FAILED,
string
notification_ids
Optional

filters the response based on the notification ids. This field can have comma(,) separted values

string
dag_id
Optional

filters the response based on the property "dag_id"

string
entities.notif_uuid
Optional

filters the response based on the nested property "entities.notif_uuid"

string
entities.policy_name
Optional

filters the response based on the nested property "entities.policy_name"

Authentication
This operation uses the following authentication methods.
Responses
200

No content

Returns Array of Task of type(s) application/json 
[
    {
        "id": "string",
        "type": "NOTIFICATION",
        "status": "IN_PROGRESS",
        "start_time": "number",
        "end_time": "number",
        "action": "ACKNOWLEDGE",
        "details": "Performing ack operation",
        "user_name": "admin",
        "notification_ids": [
            "id1",
            "id2"
        ],
        "entities": [
            {}
        ],
        "dag_id": "string"
    }
]

401

User authentication failed

Operation doesn't return any data structure

500

Internal server error

Operation doesn't return any data structure

On This Page
Task Operations
POST
Create Task
GET
Get All Tasks
GET
Get Task
PATCH
Patch Task