GET /siem/milestone_generation_tasks/{task_id}

Retrieves task status by given task ID for attack timeline.

Retrieves Attack timeline task status for particular taskId.

Table 1. GET /siem/milestone_generation_tasks/{task_id} resource details
MIME Type
application/json

Table 2. GET /siem/milestone_generation_tasks/{task_id} request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
task_id	path	Required	String	text/plain	Required. The ID of the task to retrieve.
fields	query	Optional	String	text/plain	Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 3. GET /siem/milestone_generation_tasks/{task_id} response codes
HTTP Response Code	Unique Code	Description
200		The restore was retrieved.
403	1012	An error occurred due to Attack TimeLine feature disabled.
404	1011	The ATTaskStatusDTO does not exist.
500	1000	An error occurred during the attempt to retrieve the status of the task.

Response Description

A task status object. The ATTaskStatusDTO object contains the following fields:

taskId - Long - Task Id Id
offenseId - Long - Offense Id
status - String - Task Status Id
status - Enumeration - The status of the task. The following values are available: CANCELLED, CANCELING, CANCEL_REQUESTED, COMPLETED, CONFLICT, EXCEPTION, FAILED< INITIALIZING, INTERRUPTED, PAUSED, PROCESSING, QUEUED, RESUMING
- PENDING: This is the initial state of the task once it is created.
- QUEUED: This is the initial state of the task once it is created.
- INITIALIZING: After the tasl request is received by the Attack timeline Engine it will update the status to INITIALIZING.
- PROCESSING: After the task process begins the status will be updated to PROCESSING.
- COMPLETED: If the task has completed successfully the status will be updated to COMPLETED.
- FAILED: If the task has completed with errors the status will be updated to FAILED.
- CANCEL_REQUESTED: If the task has request to cancel task the status will be updated to CANCEL_REQUESTED.
- CANCELING: If the task has accepted to cancel task the status will be updated to CANCELING.
- CANCELLED: If the task is cancelled the status will be updated to CANCELLED.
- CONFLICT: If the task is conflict with any other request task the status will be updated to CONFLICT.
- EXCEPTION: If the task has caught any exception the status will be updated to EXCEPTION.
- INTERRUPTED: If the task is interrupted the status will be updated to INTERRUPTED.
- PAUSED: If the task is paused the status will be updated to PAUSED.
- RESUMING: If the task is resuming the status will be updated to RESUMING.
createdBy - String - User Id of the task created by
lastUpdatedBy - String - User Id who has last updated task
cancelledBy - String - User Id who has cancel the task
createdTimestamp - Long - The number of milliseconds since epoch when the task was created
startTimestamp - Long - The number of milliseconds since epoch when the task was started
lastUpdateTimestamp - Long - The number of milliseconds since epoch when the task was last updated
completeTimestamp - Long - The number of milliseconds since epoch when the task was completed
taskProgress - Long - The task progress

Response Sample


{
    "cancelled_by": "String",
    "completed_timestamp": 42,
    "created_by": "String",
    "created_timestamp": 42,
    "id": "String",
    "modified_by": "String",
    "modified_timestamp": 42,
    "offense_id": 42,
    "security_profile_id": 42,
    "started_timestamp": 42,
    "status": "String",
    "task_progress": 42,
    "total_milestone_count": 42
}