POST /reference_data_collections/set_dependents_tasks/{task_status_id}

Cancel the Get Dependents request

Table 1. POST /reference_data_collections/set_dependents_tasks/{task_status_id} resource details
MIME Type
application/json

Table 2. POST /reference_data_collections/set_dependents_tasks/{task_status_id} request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
task_status_id	path	Required	Number (Integer)	text/plain	- The ID for the Get Dependents task
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 /reference_data_collections/set_dependents_tasks/{task_status_id} request body details
Parameter	Data Type	MIME Type	Description	Sample
body	Object	application/json	- the DTO of the Get Dependents Task Status with the cancel request	{ "status": "String <one of: CANCELLED, CANCELING, CANCEL_REQUESTED, COMPLETED, CONFLICT, EXCEPTION, INITIALIZING, INTERRUPTED, PAUSED, PROCESSING, QUEUED, RESUMING>" }

Table 4. POST /reference_data_collections/set_dependents_tasks/{task_status_id} response codes
HTTP Response Code	Unique Code	Description
404	13003	The Get Dependents task does not exist.
409	13004	The task is in a completed state.
422	13005	A request parameter is not valid.
500	110000	An unknown server error occurred.

Response Description

200 and the task status DTO for the Get Dependents request

Response Sample


{
    "cancelled_by": "String",
    "completed": 42,
    "created": 42,
    "created_by": "String",
    "id": 42,
    "maximum": 42,
    "message": "String",
    "modified": 42,
    "name": "String",
    "number_of_dependents": 42,
    "progress": 42,
    "started": 42,
    "status": "String <one of: CANCELLED, CANCELING, CANCEL_REQUESTED, COMPLETED, CONFLICT, EXCEPTION, INITIALIZING, INTERRUPTED, PAUSED, PROCESSING, QUEUED, RESUMING>",
    "task_components": [
        {
            "completed": 42,
            "created": 42,
            "maximum": 42,
            "message": "String",
            "modified": 42,
            "number_of_dependents": 42,
            "progress": 42,
            "started": 42,
            "status": "String <one of: CANCELLED, CANCELING, CANCEL_REQUESTED, COMPLETED, CONFLICT, EXCEPTION, INITIALIZING, INTERRUPTED, PAUSED, PROCESSING, QUEUED, RESUMING>",
            "task_sub_type": "String <one of: FIND_DEPENDENT_ARIEL_SAVED_SEARCHES, FIND_DEPENDENT_OFFENSE_SAVED_SEARCHES, FIND_DEPENDENT_ASSET_SAVED_SEARCHES, FIND_DEPENDENT_VULNERABILITY_SAVED_SEARCHES, FIND_DEPENDENT_ADE_RULES, FIND_DEPENDENT_RULES, FIND_DEPENDENT_CALCULATED_PROPERTIES, FIND_DEPENDENT_AQL_PROPERTIES, FIND_DEPENDENT_LOG_SOURCE_GROUPS, FIND_DEPENDENT_CUSTOM_PROPERTIES, FIND_DEPENDENT_REPORTS, FIND_DEPENDENT_DASHBOARDS, FIND_DEPENDENT_STORE_AND_FORWARD_POLOCIES, FIND_DEPENDENT_AUTHORIZED_SERVICES, FIND_DEPENDENT_OFFENSE_TYPES, FIND_DEPENDENT_ASSIGNED_OFFENSES, FIND_DEPENDENT_VULNERABILITIES, FIND_DEPENDENT_GROUPS, FIND_DEPENDENT_HISTORICAL_CORRELATION_PROFILES, FIND_DEPENDENT_SECURITY_PROFILES, FIND_DEPENDENT_ARIEL_INDEXING, FIND_DEPENDENT_DOMAIN, FIND_DEPENDENT_NAMED_SERVICES, FIND_DEPENDENT_FORWARDING_PROFILE>"
        }
    ]
}