TaskCreateRequest

TaskCreateRequest

Describes the create request for task object.

JSON Example

{
    "type": "NOTIFICATION",
    "status": "IN_PROGRESS",
    "action": "ACKNOWLEDGE",
    "details": "Performing ack operation",
    "notification_ids": [
        "id1",
        "id2"
    ],
    "dag_id": "xxxxxx",
    "entities": [
        {}
    ]
}

string

type

Required

Which type of task user wants to create.

Possible values are : NOTIFICATION, REMEDIATION,

string

status

Required

The current status of task.

Possible values are : IN_PROGRESS, COMPLETED, FAILED,

string

action

Required

The name of the action e.g. ADD_USER, ACKNOWLEDGE or REMEDIATION.

string

details

Optional

The details of performing action.

array of string

notification_ids

Required

List of notification ids on which the action is performed.

string

dag_id

Optional

dag id, specific to REMEDIATION tasks.

array of object

entities

Optional

This field contains the details specific to the Task type (NOTIFICATION/REMEDIATION)

Parameter To

Create Task