Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

POST /reference_data_collections/set_dependents_tasks/{task_status_id}

SUMMARY Cancel the Get Dependents request

Table 1: POST /reference_data_collections/set_dependents_tasks/{task_status_id} resource details:

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:

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:

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:

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