オブジェクト
objectsリソースを使用して、組織のアセットのリストを取得します。このリソースを使用して、エクスポートするアセットを見つけることができます。
このリソースを使用して、アセットのオブジェクトの依存関係を見つけることもできます。
注: このリソースは、動的レート制限を使用します。システムで大量の要求またはサイズが発生すると、応答が遅くなったり、「要求が多すぎます」というエラーメッセージが表示されて失敗したりすることがあります。
アセットの検索
オブジェクトリソースを使用して、クエリパラメータで組織内のアセットを検索します。
クエリパラメータは、アセットタイプ、タグ、フォルダの場所、最終更新日時、アセットを最後に更新したユーザー、ソース管理メタデータにフィルタを含みます。取得するアセットの最大数、スキップする要素の数などを指定できます。
応答には、最大200個のアセットを含めることができます。要求でアセットの数が200個を超える結果となるクエリパラメータを使用している場合は、skipパラメータを使用して追加の要求を送信して、前の応答で受け取ったアセットをスキップできます。
読み取るための特権がないアセットは応答に含まれません。
GET要求
アセットのリストを要求するには、次のURIを使用します。
/public/core/v3/objects?<query parameters>
URIで以下のクエリパラメータを使用できます。
パラメータ | タイプ | 説明 |
---|
q | String | クエリフィルタ。 |
limit | Int | 取得するアセットの最大数。上限は200です。 |
skip | Int | スキップする要素の数。例えば、値を4に設定すると、リストの最初の4つのアセットが除外されます。 |
以下のフィールドを使用してクエリフィルタを定義できます。
フィールド | タイプ | 演算子 | 説明 |
---|
type | String | == ! = | アセットタイプ。タイプは、プロジェクト、フォルダ、または次のアセットタイプのいずれかになります。 データ統合の場合、オブジェクトは次のいずれかのタイプになります。 - - DTEMPLATE。マッピング。
- - MTT。マッピングタスク。
- - DSS。同期タスク。
- - DMASK。マスキングタスク。
- - DRS。レプリケーションタスク。
- - DMAPPLET。データ統合で作成されたマップレット。
- - MAPPLET。PowerCenterマップレット。
- - BSERVICE。ビジネスサービス定義。
- - HSCHEMA。階層スキーマ。
- - PCS。PowerCenterタスク。
- - FWCONFIG。固定長の設定。
- - CUSTOMSOURCE。保存済みクエリ。
- - MI_TASK。一括取り込みタスク。
- - WORKFLOW。リニアタスクフロー。
- - TASKFLOW
- - UDF。ユーザー定義関数。
- - PROJECT
- - FOLDER
アプリケーションの統合の場合、オブジェクトは次のいずれかのタイプになります。 - - PROCESS
- - GUIDE
- - AI_CONNECTION
- - AI_SERVICE_CONNECTOR
- - PROCESS_OBJECT
B2Bゲートウェイの場合、オブジェクトは次のいずれかのタイプになります。 - - B2BGW_MONITOR
- - B2BGW_CUSTOMER
- - B2BGW_SUPPLIER
MDM SaaSの場合、オブジェクトは次のいずれかのタイプになります。 - - MDM_BUSINESS_ENTITY
- - MDM_REFERENCE_ENTITY
- - MDM_HIERARCHY
- - MDM_RELATIONSHIP
- - MDM_JOB_DEFINITION
- - MDM_AUTHORIZATION
- - MDM_BUSINESS_EVENT
- - MDM_REPORT_SET
- - MDM_REPORT
- - MDM_DYNAMIC_POOL
- - MDM_APPLICATION
- - MDM_SRC_SYSTEM
- - MDM_APP_COMPONENT
- - MDM_APP_PAGE
Data Qualityの場合、オブジェクトは次のいずれかのタイプになります。 - - CLEANSE
- - DEDUPLICATE
- - DICTIONARY
- - EXCEPTION
- - LABELER
- - PARSE
- - RULE_SPECIFICATION
- - VERIFIER
オブジェクトタイプは大文字と小文字を区別しません。 |
location | String | == | アセットが置かれているプロジェクトおよびフォルダのパス(Default/Salesなど)。 |
updateTime | Date | < <= == => > ! = | アセットの最終更新日時。 |
updatedBy | String | == ! = | アセットを最後に更新したユーザー。ユーザーにはuserNameの値を使用します。 |
tag | String | == | アセットに関連付けられたタグ。 |
sourceControl.checkedOutBy | String | ==, ! = | アセットをチェックアウトしたユーザー。 |
sourceControl.checkedOutTime | Date | <,<=,==,=>,>, ! = | アセットがチェックアウトされた時間。 |
sourceControl.hash | String | ==, ! = | ソース管理ハッシュ。ワイルドカード(*)を使用する一部のハッシュをサポートします。 |
sourceControl.lastCheckinBy | String | ==, ! = | アセットに最後にチェックしたユーザー。 |
sourceControl.lastCheckinTime | Date | <,<=,==,=>,>, ! = | アセットがチェックインされた最終時刻。 |
sourceControl.lastPullTime | Date | <,<=,==,=>,>, ! = | アセットがプルされた最終時刻。 |
sourceControl.sourceControlled | Boolean | ==, ! = | アセットがソース管理されるかどうか。 |
customAttributes.publishedBy | String | ==, ! = | アセットをパブリッシュしたユーザー。 アプリケーションの統合に適合できます。 |
customAttributes.publicationDate | Date | <,<=,==,=>,>, ! = | アセットがパブリッシュされた日付。 アプリケーションの統合に適合できます。 |
GET要求の例
クエリパラメータを使用してアセットのリストを要求する例を以下に示します。
- •最終更新日が2018年11月21日以降のデータ統合マッピングタスクのリストを要求するには、次のようなURIを使用します。
/public/core/v3/objects?q=type=='MTT' and updateTime>=2018-11-21T12:00:00Z
- •最終更新日が2018年11月21日以降のデータ統合マッピングタスクのリストを要求するには、次のようなURIを使用します。
/public/core/v3/objects?q=type=='MTT' and updateTime>=2018-11-21T12:00:00Z
- •Default/SalesOppsフォルダにある、最終更新日が2018年3月27日より前のアセットのリストを要求するには、次のようなURIを使用します。
/public/core/v3/objects?q=location=='Default/SalesOpps' and updateTime<2018-03-27T12:00:00Z
- •UpsellOppsタグが関連付けられた、最終更新日が2018年1月10日以降のアセットのリストを要求するには、次のようなURIを使用します。
/public/core/v3/objects?q=tag=='UpsellOpps' and updateTime>=2018-01-10T12:00:00Z
- •最終更新日が2017年12月30日の、データ統合マッピング以外のアセットのリストを、上限を150として要求するには、次のようなURIを使用します。
/public/core/v3/objects?q=type!='MAPPING' and updateTime=2017-12-30T12:00:00Z&max=150
- • 200個の制限を超えるアセットのリストを要求するには、追加の要求で次のURIを使用します。
/public/core/v3/objects?limit=200&skip=200
GET応答
成功した場合は、アセットのリストと、クエリ結果に基づくアセットの数を返します。エラーが発生した場合は、エラーオブジェクトを返します。
注: 結果のサイズが大きい場合(例えば、1000個を超えるオブジェクト)、応答で返されるカウントには最大90秒間の誤差がある可能性があります。取得リストは、APIで戻されたカウントが変更されていない場合でも、要求に含まれるtopパラメータとlimitパラメータを使用してすべての結果を返します。また、カウントフィールドが応答の最初のフィールドではない場合もあります。
成功した応答には次の情報が含まれます。
フィールド | タイプ | 説明 |
---|
count | String | フィルタクエリに一致するアセットの数。 |
objects | - | 各アセットの情報が含まれます。 |
id | String | アセットのグローバル一意識別子。ジョブ要求を送信する際にはこのフィールドの値をtaskFederatedIdの値として使用します。 |
path | String | プロジェクト、フォルダ、およびオブジェクト名を含むアセットのフルパス。 |
type | String | アセットのタイプ。 |
description | String | アセットの説明。 |
updatedBy | String | アセットを前回更新したユーザーの名前。システム作成のアセット(デフォルトプロジェクト、アドオンバンドルフォルダなど)の場合、このフィールドの値はInformaticaになります。 |
updateTime | String | アセットの最終更新日時。 |
tag | String | アセットに関連付けられたタグ。 |
sourceControl | - | アセットのソース管理メタデータを含みます。 |
sourceControl.checkedOutBy | String | オブジェクトをチェックアウトしたユーザー。 |
sourceControl.checkedOutTime | Date | アセットがチェックアウトされた時間。 |
sourceControl.hash | String | アセットのソース管理ハッシュ。 |
sourceControl.lastCheckinBy | String | オブジェクトをチェックアウトしたユーザー。 |
sourceControl.lastCheckinTime | Date | アセットが最後にチェックインされた時間。 |
sourceControl.lastPullTime | Date | アセットが最後にプルされた時間。 |
sourceControl.sourceControlled | Boolean | アセットがソース管理されるかどうか。 |
customAttributes | - | アプリケーションの統合アセットにパブリッシュしているメタデータを含みます。 |
customAttributes.publishedBy | String | customAttributesオブジェクトに含まれます。 アセットをパブリッシュしたユーザー。 アプリケーションの統合に適合できます。 |
customAttributes.publicationDate | Date | customAttributesオブジェクトに含まれます。 アセットがパブリッシュされた日付。 アプリケーションの統合に適合できます。 |
GETの例
次の例の要求は、P1フォルダにあるアセットのリストを取得して、応答に含まれるアセットを2つまでに制限します。
GET /saas/public/core/v3/objects?q=location=='P1'&limit=2
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: 3H05q5PicfolyDXnp3N06c
応答には、次の例のように、最初の2つのアセットの情報が含まれます。
{
"count": 4,
"objects": [
{
"id": "1a3TnUrT2cfiwQGtkWQEUy",
"path": "P1/F1",
"type": "Folder",
"description": "",
"updatedBy": "mma@infa.com",
"updateTime": "2018-12-17T00:29:29Z"
"tags": [
"tag3",
"tag4"
],
"sourceControl": {
"checkedOutBy": "mma@infa.com",
"checkedOutTime": "2020-05-05T17:37:13Z",
"hash": "3e082fb9bcb2349e9f0a4fb516c739610c869391",
"lastCheckinTime": "2020-05-05T04:51:09Z",
"lastCheckinBy": "mma@infa.com",
"lastPullTime": null,
"sourceControlled": true
},
"customAttributes": {
"publishedBy": "mma@infa.com"
}
},
{
"id": "0dGB1jBDWcuhrTxG9Gy1Kh",
"path": "P1/Mapping1",
"type": "DTEMPLATE",
"description": "",
"updatedBy": "mma@infa.com",
"updateTime": "2018-12-10T02:25:14Z"
"tags": [
"tag3",
"tag4"
],
"sourceControl": {
"checkedOutBy": null,
"checkedOutTime": null,
"hash": "a98327e09883bb30583574b48113bf1d3ab9d494",
"lastCheckinTime": "2020-05-27T20:43:05Z",
"lastCheckinBy": "mma@infa.com",
"lastPullTime": null,
"sourceControlled": true
},
"customAttributes": {
"publishedBy": "mma@infa.com",
"publicationDate": "2020-05-25T11:43:12Z"
}
}
]
}
アセットの依存関係の検索
オブジェクトリソースを使用して、アセットの依存関係のリストを取得します。アセットが使用するオブジェクトのリスト、またはアセットを使用するオブジェクトのリストを受け取ることができます。
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"
}
]
}