Get Task
This API retrieves the specific tasks using id.
Request
URI
GET
https://{api_host}/tcsa.host.com/tcsa/api/v1/tasks/{id}
COPY
Path Parameters
string
id
Required
The id of task.
Responses
200
No content
Returns 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"
}string
id
Required
Unique identifier for task.
string
type
Required
Which type of task user wants to create.
Possible values are : NOTIFICATION, REMEDIATION, COLLECTOR, ESCALATION,
string
status
Required
The current status of task.
Possible values are : IN_PROGRESS, COMPLETED, FAILED,
number
start_time
Required
The start time of task in epoch millis.
number
end_time
Required
The end time of task in epoch millis.
string
action
Required
The name of the action e.g. ADD_USER, ACKNOWLEDGE or REMEDIATION.
string
details
Optional
The details of performing action.
string
user_name
Required
The name of the user
array of string
notification_ids
Required
List of notification ids on which the action is performed.
array of object
entities
Required
This filed contains the details specific to the Task type (NOTIFICATION/REMEDIATION)
string
dag_id
Optional
This field is specific to remediation task. dag_id represent dag_id created for airflow pipeline.
401
User authentication failed
Operation doesn't return any data structure
403
Access to the requested resource/operation is forbidden
Operation doesn't return any data structure
404
Cannot find requested resource
Operation doesn't return any data structure
500
Internal server error
Operation doesn't return any data structure