REST APIリファレンス

前へ次へ

アセットの依存関係の検索

オブジェクトリソースを使用して、アセットの依存関係のリストを取得します。アセットが使用するオブジェクトのリスト、またはアセットを使用するオブジェクトのリストを受け取ることができます。

GET要求

アセットの依存関係のリストを要求するには、次のURIを使用します。

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

URIで次のパラメータを使用できます。

パラメータ	タイプ	必須	説明
refType	Enum	はい	アセットが使用するオブジェクトを一覧表示するか、アセットを使用するオブジェクトを一覧表示するか。以下のいずれかの値を使用します。 uses。アセットが使用するオブジェクト。 usedBy。アセットを使用するオブジェクト。 1つの参照タイプを要求に含めることができます。
limit	Int	-	返すオブジェクトトの最大数。上限は50です。デフォルトは25です。
skip	Int	-	先頭からスキップする要素の数。デフォルトは0です。

GET応答

成功した場合は、依存オブジェクトのリストと、クエリ結果に基づく依存オブジェクトの数を返します。エラーが発生した場合は、エラーオブジェクトを返します。

結果のサイズが大きい場合（例えば、1000個を超えるオブジェクト）、応答で返されるカウントには最大90秒間の誤差がある可能性があります。取得リストは、APIで戻されたカウントが変更されていない場合でも、要求に含まれるtopパラメータとlimitパラメータを使用してすべての結果を返します。また、カウントフィールドが応答の最初のフィールドではない場合もあります。

正常に実行された応答は次の情報を返します。

フィールド	タイプ	説明
id		アセットのグローバル一意識別子。
count		依存オブジェクトの数。
references	Collection<複合型>	アセットを使用する、またはアセットが使用する各オブジェクトの情報が含まれます。
id	String	参照オブジェクトに含まれます。オブジェクトのグローバル一意識別子。
appContextId	String	参照オブジェクトに含まれます。コンテキスト内のオブジェクトのID。詳細を取得するか、オブジェクトに変更を加えるには、サービス固有のREST API呼び出しでappContextId値をオブジェクトまたはタスクIDとして使用できます。一括取り込みとデータ統合にのみ適用されます。
path	String	参照オブジェクトに含まれます。プロジェクト、フォルダ、およびオブジェクト名を含むオブジェクトのフルパス。
type	String	参照オブジェクトに含まれます。オブジェクトのタイプ。
description	String	参照オブジェクトに含まれます。オブジェクトの説明。
updateTime	String	参照オブジェクトに含まれます。オブジェクトの最終変更日時。

GETの例

次の例は、アセットが使用するオブジェクトのリストを受信する要求です。応答では25個のオブジェクトに制限されています。

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

次の例に示すように、応答にはアセットが使用するオブジェクトのリストが含まれます。

{
  "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" 
    }
  ]
}

オブジェクト

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal