Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
ON THIS PAGE
 

POST /ariel/saved_search_dependent_tasks/{task_id}

SUMMARY Cancels the dependent Ariel saved search task.

Cancels the dependent Ariel saved search task.

Table 1: POST /ariel/saved_search_dependent_tasks/{task_id} resource details:

POST /ariel/saved_search_dependent_tasks/{task_id} resource details

MIME Type

application/json

Table 2: POST /ariel/saved_search_dependent_tasks/{task_id} request parameter details:

POST /ariel/saved_search_dependent_tasks/{task_id} request parameter details

Parameter Type Optionality Data Type MIME Type Description

task_id

path

Required

Number (Integer)

text/plain

null

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 /ariel/saved_search_dependent_tasks/{task_id} request body details:

POST /ariel/saved_search_dependent_tasks/{task_id} request body details

Parameter Data Type MIME Type Description Sample

task

Object

application/json

null

{ "status": "String <one of: CANCELLED, CANCELING, CANCEL_REQUESTED, COMPLETED, CONFLICT, EXCEPTION, INITIALIZING, INTERRUPTED, PAUSED, PROCESSING, QUEUED, RESUMING>" }
Table 4: POST /ariel/saved_search_dependent_tasks/{task_id} response codes:

POST /ariel/saved_search_dependent_tasks/{task_id} response codes

HTTP Response Code Unique Code Description

200

The delete task status was retrieved.

404

1002

The dependent task status does not exist.

409

1004

The task is in a completed state.

422

1005

A request parameter is not valid.

500

1020

An error occurred during the attempt to update the dependent task status.

Response Description

A Dependent Task Status object and the location header set to the task status url "/api/ariel/saved_search_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 cancellation of the task.
  • created - Long - The time in milliseconds since epoch since the task was created.
  • started - Long - The time in milliseconds since epoch since the task was started.
  • modified - Long - The time in milliseconds since epoch since the task was modified.
  • completed - Long - The time in milliseconds since epoch since the task was completed.
  • number_of_dependents - Long - The number of dependents found. the vaalue is null until the task completes.
  • maximum - Long - The maximum number of objects to check for dependency.
  • progress - Long - The number of objects that were 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 of the sub-task.
    • 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 that were checked for dependency.
    • created - Long - The time in milliseconds since epoch since the sub-task was created.
    • started - Long - The time in milliseconds since epoch since the sub-task was started.
    • modified - Long - The time in milliseconds since epoch since the sub-task was modified.
    • completed - Long - The time in milliseconds since epoch since the sub-task was completed.

Response Sample