Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

GET /reference_data/sets/{name}/dependents

Retrieves the objects that depend on the reference data set.

Retrieves the objects that depend on the reference data set.

Table 1: GET /reference_data/sets/{name}/dependents Resource Details

MIME Type

application/json

Table 2: GET /reference_data/sets/{name}/dependents Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

name

path

Required

String

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.

Table 3: GET /reference_data/sets/{name}/dependents Response Codes

HTTP Response Code

Unique Code

Description

202

 

The reference data set dependents retrieval was accepted and is in progress.

404

1002

The reference data set does not exist.

500

1020

An error occurred during the attempt to initiate the reference data set dependents retrieval task.

Response Description

A Dependents Task Status object and the location header set to the task status URL "/api/reference_data/sets/set_dependents_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 of the task.

  • 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 value 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