目次

Search

  1. はじめに
  2. Informatica Intelligent Cloud Services REST API
  3. プラットフォームREST APIバージョン2リソース
  4. プラットフォームREST APIバージョン3リソース
  5. データ統合 REST API
  6. 一括取り込みファイルREST API
  7. 一括取り込みストリーミングREST API
  8. Model Serve REST API
  9. RunAJobユーティリティ
  10. ParamSetCliユーティリティ
  11. REST APIコード
  12. REST APIリソースクイックリファレンス

REST APIリファレンス

REST APIリファレンス

要求ヘッダー

要求ヘッダー

要求ヘッダーはバージョン2とバージョン3のリソースで少し異なります。
バージョン2の呼び出しでは、REST API要求ヘッダーで次の形式を使用します。
<METHOD> <serverUrl>/<URI> HTTP/<HTTP version> Content-Type: application/<json | xml>
Accept: application/<json | xml>
icSessionId: <SessionId>
バージョン3の呼び出しでは、REST API要求ヘッダーで次の形式を使用します。
<METHOD> <baseApiUrl>/<URI> HTTP/<HTTP version> Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <SessionId>
Postmanなどのツールを使用する場合、要求にはHTTPバージョンが自動的に含められることに注意してください。URLにHTTPバージョンを入力すると、HTTPバージョンがURLで2回出現するため、要求が成功しません。
次のリストは、バージョン2とバージョン3の要求ヘッダーの形式の属性を示します。
属性
必須
説明
METHOD
はい
使用するメソッド(GET、POST、DELETEなど)。
serverUrl
ほとんどのv2リソースで必須
loginとregisterを除くすべてのバージョン2リソースのベースURL。
serverUrlにはプレースホルダを使用し、プレースホルダをloginリソースによって返される
Informatica Intelligent Cloud Services
URLに置き換えます。
loginおよびregisterリソースでは、リソースにリストされるURLを使用します。
baseApiUrl
ほとんどのv3リソースで必須
loginを除くすべてのバージョン3リソースのベースURL。
baseApiUrlにはプレースホルダを使用し、プレースホルダをloginリソースによって返される
Informatica Intelligent Cloud Services
URLに置き換えます。
loginリソースでは、リソース定義にリストされるURLを使用します。
URI
ほとんどのリソースで必須
リソースURI。
URIにはベースURLとリソース名を含めます。パラメータを含めることもできます。
loginおよびregisterリソースでは、リソース定義にリストされるURLを使用します。
HTTP version
はい
使用しているHTTPバージョン。
Postmanなどの一部のツールではヘッダーにHTTPバージョンが自動的に含められます。
Content-Type
POST要求で必須
要求の形式。次のいずれかのオプションを使用します。
  • application/json。要求をJSONとして読み取ります。
  • application/xml。要求をXMLとして読み取ります。バージョン2リソースにのみ適用できます。
デフォルトはjsonです。
承認
いいえ
受信する要求形式。次のいずれかのオプションを使用します。
  • application/json。要求をJSONとして送信します。
  • application/xml。要求をXMLとして送信します。バージョン2リソースにのみ適用できます。
デフォルトはjsonです。
icSessionId
ほとんどのv2リソースで必須
Informatica Intelligent Cloud Services
セッションID。loginとregisterを除くすべてのバージョン2リソースで必須。
sessionIdにはプレースホルダを使用し、プレースホルダをloginリソースによって返されるセッションIDに置き換えます。
INFA-SESSION-ID
ほとんどのv3リソースで必須
Informatica Intelligent Cloud Services
セッションID。loginを除くすべてのバージョン3リソースで必須。
sessionIdにはプレースホルダを使用し、プレースホルダをloginリソースによって返されるセッションIDに置き換えます。