Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

GET /reference_data/tables/{name}/dependents

 

Find the objects that depend on the Reference Data Tables

Find the objects that depend on the Reference Data Tables

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

MIME Type

application/json

Table 2: GET /reference_data/tables/{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/tables/{name}/dependents Response Codes

HTTP Response Code

Unique Code

Description

202

 

The Reference Data Tables dependents retrieval has been accepted and is in progress

404

1002

The Reference Data Tables does not exist

500

1020

An error occurred while attempting to initiate the Reference Data Tables dependents retrieval task

Response Description

A Dependents Task Status object and the location header set to the task status url "/api/reference_data/tables/tables_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 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