GET /reference_data/tables_dependent_tasks/{task_id}
Retrieve the dependent the Reference Data Tables task status.
Retrieve the dependent Reference Data Tables task status.
MIME Type |
---|
application/json |
Parameter | Type | Optionality | Data Type | MIME Type | Description |
---|---|---|---|---|---|
task_id |
path |
Required |
Number (Integer) |
text/plain |
null |
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. |
HTTP Response Code | Unique Code | Description |
---|---|---|
200 |
The Delete Task Status has been retrieved. |
|
404 |
1002 |
The Delete Task Status does not exist. |
500 |
1020 |
An error occurred while attempting to retrieve the Delete Task Status. |
Response Description
A Dependent Task Status object and the location header set to the task status url "/api/reference_data/tables/tables_dependent_tasks/{task_id}". A Dependent Task Status object contains the following fields:
- id - Long - The ID of the task.
- message - String - The localized task message.
- status - String - The current state that the task is in.
- name - String - The name of the task.
- created_by - String - The name of the user who started the task.
- cancelled_by - String - The name of the user who requested to cancel the task.
- created - Long - The time in milliseconds since epoch of when the task was created.
- started - Long - The time in milliseconds since epoch of when the task was started.
- modified - Long - The time in milliseconds since epoch of when the task was modified.
- completed - Long - The time in milliseconds since epoch of when the task was completed.
- number_of_dependents - Long - The number of dependents found. Value is null until task completes.
- maximum - Long - The maximum number of objects to check for dependency.
- progress - Long - The number of objects checked for dependency.
- task_components - Array - An array of task component objects. A task component object contains the following fields
- message - String - The localized sub-task status message.
- status - String - The current state the sub-task is in.
- sub_task_type - String - The type of the sub-task
- maximum - Long - The maximum number of objects to check for dependency.
- progress - Long - The number of objects checked for dependency.
- created - Long - The time in milliseconds since epoch of when the sub-task was created.
- started - Long - The time in milliseconds since epoch of when the sub-task was started.
- modified - Long - The time in milliseconds since epoch of when the sub-task was modified.
- completed - Long - The time in milliseconds since epoch of when the sub-task was completed.
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>"
}
]
}