POST /siem/milestone_generation_tasks

Creates a milestone generation task for an offense.

Creates a milestone generation task for the specified offense.

Note: Only a single task can be created per offense at a time. A completed task has the status of COMPLETED or EXCEPTION.

Table 1. POST /siem/milestone_generation_tasks resource details
MIME Type
application/json

Table 2. POST /siem/milestone_generation_tasks request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
fields	header	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. POST /siem/milestone_generation_tasks request body details
Parameter	Data Type	MIME Type	Description	Sample
taskStatusData	Object	application/json	null	{ "offense_id": 1011 }

Table 4. POST /siem/milestone_generation_tasks response codes
HTTP Response Code	Unique Code	Description
403	1012	An error occurred due to Attack TimeLine feature disabled.
404	1011	null
404	1002	null
409	1008	null
422	1005	null
500	1020	null

Response Description

The created task object containing the following fields:

id - String - Task ID
offense_id - Long - Offense ID
status - String - Task Status
status - Enumeration - The status of the task. The following values are available: CANCELLED, CANCELING, CANCEL_REQUESTED, COMPLETED, CONFLICT, EXCEPTION, INITIALIZING, INTERRUPTED, PAUSED, PROCESSING, QUEUED, RESUMING
- INITIALIZING: After the task 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.
- EXCEPTION: If the task has caught any exception the status will be updated to EXCEPTION.
- CANCELLED: If the task is cancelled the status will be updated to CANCELLED.
- CANCELING: If the task has accepted to cancel task the status will be updated to CANCELING.
- CANCEL_REQUESTED: If the task has request to cancel task the status will be updated to CANCEL_REQUESTED.
- CONFLICT: If the task is conflict with any other request task the status will be updated to CONFLICT.
- 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.
- QUEUED: If the task is queued the status will be updated to QUEUED.
- RESUMING: If the task is resuming the status will be updated to RESUMING.
created_by - String - User ID of the task creator
modified_by - String - User ID who last updated task
cancelled_by - String - User ID who cancelled the task
created_timestamp - Long - The number of milliseconds since epoch when the task was created
started_timestamp - Long - The number of milliseconds since epoch when the task was started
modified_timestamp - Long - The number of milliseconds since epoch when the task was last updated
completed_timestamp - Long - The number of milliseconds since epoch when the task was completed
task_progress - Long - The task progress percentage (0-100)
total_milestone_count - Long - Total number of milestones generated

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
}