REST API Reference

Back Next

Finding asset dependencies

Use the objects resource to get a list of dependencies for an asset. You can receive a list of objects that the asset uses or a list of objects that use the asset.

GET request

To request a list of dependencies for an asset, use the following URI:

/public/core/v3/objects/<objectId>/references?<parameters>

You can use the following parameters in the URI:

Parameter	Type	Required	Description
refType	Enum	Yes	Whether to list objects that the asset uses or objects that use the asset. Use one of the following values: uses. Objects that the asset uses. usedBy. Objects that use the asset. One reference type can be included in a request.
limit	Int	-	Maximum number of objects to return, up to 50. Default is 25.
skip	Int	-	Number of elements to skip from the beginning.. Default is 0.

GET response

If successful, returns a list of dependent objects and a count of the of the dependent objects based on the query results. If errors occur, returns an error object.

If the result size is large, for example, over 1000 objects, the count returned in the response might not be precise for up to 90 seconds. The fetch list returns all the results using the top and limit parameters included in the request, even though the returned count in the API might not have changed. Also, the count field might not be the first field in the response.

A successful response returns the following information:

Field	Type	Description
id		Global unique identifier for the asset.
count		Number of dependent objects.
references	Collection <complex type>	Includes information for each object that uses or is used by the asset.
id	String	Included in the references object. Global unique identifier for the object.
appContextId	String	Included in the references object. ID of the object in context. To get details or make changes to the object, you can use the appContextId value as the object or task ID in a service-specific REST API call. Applicable only to Data Ingestion and Replication and Data Integration .
path	String	Included in the references object. Full path of the object including project, folder, and object name.
type	String	Included in the references object. Type of object.
description	String	Included in the references object. Description of the object.
updateTime	String	Included in the references object. Last time the object was modified.

GET example

The following example is a request to receive a list of objects that an asset uses with a limit of 25 objects in the response:

GET /saas/public/core/v3/objects/1a3TnUrT2cfiwQGtkWQEUy/references?refType=Uses&skip=0&limit=25  
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: 3H05q5PicfolyDXnp3N06c

The response includes a list of objects that the asset uses, as shown in the following example:

{
  "id": "1a3TnUrT2cfiwQGtkWQEUy",
  "count": 2,
  "references": [
    {
      "id": "2iXOKghGpySlgv6ifQImyl",
      "appContextId": "N0A1700000000001J",
      "path": "Default/Mapping1",
      "type": "DTEMPLATE",
      "description": "My Mapping 1",
      "updateTime": "2018-04-12T21:34:11Z"
    }
    { 
      "id": "1fOqrwpFvLkimAkFFvIiwl",
      "appContextId": "N0A1700000000001K", 
      "path": "FF_Conn_1", 
      "type": "Connection", 
      "description": null, 
      "updateTime": "2018-04-12T21:33:11Z" 
    }
  ]
}

Objects

Download Guide

Watch

Comments

Cloud Data Integration Homepage