REST APIリファレンス > プラットフォームREST APIバージョン3リソース > ルックアップ
  

ルックアップ

ルックアップリソースを使用して、オブジェクトのID、名前、パス、またはタイプの属性をルックアップします。

POST要求

このリソースは、通常、エクスポート要求やジョブ要求で使用するオブジェクトのIDを取得するのに使用されます。このリソースを使用してオブジェクトのIDを取得する際には、ルックアップ要求にオブジェクトのパスとタイプを含めます。
ジョブ要求の場合は、ジョブ要求のフェデレーションタスクIDフィールドのルックアップ応答で返されるIDフィールドの値を使用します。
ルックアップ情報を要求するには、次のURIを使用します。
/public/core/v3/lookup
objectsオブジェクトに次のフィールドを使用できます。
フィールド
タイプ
必須
説明
id
String
オブジェクトのパスとタイプが含まれない場合に必要です。
オブジェクトのグローバル一意識別子。
path
String
オブジェクトIDが含まれない場合にタイプで必要です。
プロジェクト、フォルダ、およびオブジェクト名を含むオブジェクトのフルパス。
type
String
オブジェクトIDが含まれない場合にパスで必要です。
オブジェクトのタイプ。
次のいずれかの値を使用します。
  • - PROJECT
  • - FOLDER
または、次のアセットタイプのいずれかを使用します。
データ統合の場合、オブジェクトは次のいずれかのタイプになります。
  • - DTEMPLATE。マッピング。
  • - MTT。マッピングタスク。
  • - DSS。同期タスク。
  • - DMASK。マスキングタスク。
  • - DRS。レプリケーションタスク。
  • - DMAPPLET。データ統合で作成されたマップレット。
  • - MAPPLET。PowerCenterマップレット。
  • - CONNECTION。
  • - AGENT。Secure Agent。
  • - AGENTGROUP。ランタイム環境。
  • - BSERVICE。ビジネスサービス定義。
  • - HSCHEMA。階層スキーマ。
  • - PCS。PowerCenterタスク。
  • - FWCONFIG。固定長の設定。
  • - CUSTOMSOURCE。保存済みクエリ。
  • - MI_FILE_LISTENER。ファイルリスナ。
  • - MI_TASK。ファイル取り込みとレプリケーション。
  • - DBMI_TASK。データベース取り込みとレプリケーション
  • - APPMI_TASK.アプリケーション取り込みとレプリケーション。
  • - WORKFLOW。リニアタスクフロー。
  • - SCHEDULE
  • - SCHEDULE_JOB
  • - SCHEDULE_BLACKOUT。スケジュールのブラックアウト期間。
  • - TASKFLOW
  • - UDF。ユーザー定義関数。
アプリケーションの統合の場合、オブジェクトは次のいずれかのタイプになります。
  • - PROCESS
  • - GUIDE
  • - AI_CONNECTION
  • - AI_SERVICE_CONNECTOR
  • - PROCESS_OBJECT
B2Bゲートウェイの場合、オブジェクトは次のいずれかのタイプになります。
  • - B2BGW_MONITOR
  • - B2BGW_CUSTOMER
  • - B2BGW_SUPPLIER
オブジェクトタイプは大文字と小文字を区別しません。

POST応答

成功した場合はオブジェクト情報を、エラーが発生した場合はエラーオブジェクトを返します。
正常に実行された場合は、各オブジェクトの次のルックアップ情報を返します。
フィールド
タイプ
説明
objects
コレクション
ルックアップが要求されるオブジェクトのコレクション。
id
String
オブジェクトのグローバル一意識別子。ジョブ要求を送信する際にはこのフィールドの値をtaskFederatedIdの値として使用します。
path
String
プロジェクト、フォルダ、およびオブジェクト名を含むオブジェクトのフルパス。
type
String
オブジェクトのタイプ。
description
String
オブジェクトの説明。
updatedBy
String
スケジュールを更新したユーザー。
updateTime
String
オブジェクトの最終変更日時。

POSTの例

次の例は、8つのオブジェクトのルックアップ要求を示しています。
POST <baseApiUrl>/public/core/v3/lookup
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: 9KA11tLGqxVcGeul8SQBK3

{
"objects": [{
"id" : "2iXOKghGpySlgv6ifQImyl"
}, {
"path" : "Default/Synchronization Task1",
"type" : "DSS"
}, {
"id" : "hTrrjm1kawScIm1BGEj6UV"
}, {
"path" : "My Project",
"type" : "Project"
}, {
"path" : "My Project/DSS Tasks Folder",
"type" : "Folder"
}, {
"path": "USW1R90FPZXD",
"type": "Agent"
}, {
"path": "USW1R90FPZXD",
"type": "AgentGroup"
}, {
"path": "FF_Conn_1",
"type": "Connection"
}]
}
応答には、次の例に示されるように各オブジェクトのルックアップ情報が含まれます。
{
"objects": [
{
"id": "2iXOKghGpySlgv6ifQImyl",
"path": "Default/Mapping1",
"type": "DTEMPLATE",
"description": "My Mapping 1",
"updateTime": "2018-04-13T20:44:37Z"
},
{
"id": "1fOqrwpFvLkimAkFFvIiwl",
"path": "Default/Synchronization Task1",
"type": "DSS",
"description": "Sync Data Task",
"updateTime": "2018-04-13T20:45:44Z"
},
{
"id": "hTrrjm1kawScIm1BGEj6UV",
"path": "My Project/Linear Taskflow1",
"type": "WORKFLOW",
"description": null,
"updateTime": "2018-04-13T20:50:31Z"
},
{
"id": "0EzsUXQ1RnkbKD6VyOukCb",
"path": "My Project",
"type": "Project",
"description": "",
"updateTime": "2018-04-13T20:40:07Z"
},
{
"id": "dRNcMcUVou5lh5kihmEAWl",
"path": "My Project/DSS Tasks Folder",
"type": "Folder",
"description": "DSS Tasks",
"updateTime": "2018-04-13T20:49:17Z"
},
{
"id": "1a8moeCNtm4fh5vGcUhxOj",
"path": "USW1R90FPZXD",
"type": "AGENT",
"description": null,
"updateTime": "2018-04-12T19:01:16Z"
},
{
"id": "9iJP8TdBOMujA7eH2CTm8l",
"path": "USW1R90FPZXD",
"type": "AgentGroup",
"description": null,
"updateTime": "2018-04-12T19:01:17Z"
},
{
"id": "5VkwOw6Jd8RglXEkxDu0ya",
"path": "FF_Conn_1",
"type": "Connection",
"description": null,
"updateTime": "2018-04-12T21:34:11Z"
}
]
}