目次

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リファレンス

ログイン

ログイン

このリソースを使用して、
Informatica Intelligent Cloud Services
ユーザーアカウントを使用して組織にログインできます。
ログイン応答には、REST APIセッション中に送信する要求に含めるベースURLとセッションIDの値が含まれています。
このlogoutリソースを使用して、セッションを終了します。
SAMLシングルサインオンを使用してログインするには、loginSamlを参照してください。
Salesforce資格情報を使用してログインするには、loginSfを参照してください。
チームでは、開発用の組織とテスト用の組織など、複数の組織を使用している場合があります。ログインに使用するユーザー資格情報によって、アクセスする組織が決定されます。

POST要求

ログインするには、次のURLを使用します。
https://<cloud provider>-<region>.informaticacloud.com/ma/api/v2/user/login
クラウドプロバイダとリージョンの値は、組織が使用するPOD(デプロイメントのポイント)の名前に対応します。次の表に、POD名と、ログインURLで使用する、それに対応するクラウドプロバイダとリージョンを示します。
POD名
クラウドプロバイダ - リージョン
USW1
dm-us
USE2
dm-us
USW3
dm-us
USE4
dm-us
USW5
dm-us
USE6
dm-us
USW1-1
dm1-us
USW3-1
dm1-us
USW1-2
dm2-us
CAC1
dm-na
APSE1
dm-ap
APSE2
dm1-apse
APNE1
dm1-ap
APAUC1
dm1-apau
EMW1
dm-em
EMC1
dm1-em
UK1
dm-uk
例えば、組織でAPNE1 PODを使用している場合は、次のURLを使用します。
https://dm1-ap.informaticacloud.com/ma/api/v2/user/login
組織が使用しているPODの名前がわからない場合は、組織の管理者またはInformaticaグローバルカスタマサポートにお問い合わせください。
POD名、対応するクラウドプロバイダ、およびリージョンの詳細については、ナレッジベースの「Product Availability Matrix (PAM) for Informatica Intelligent Cloud Services」を参照してください。
ログインオブジェクトの次の属性を使用します。
フィールド
タイプ
必須
説明
username
String
ログインする組織の
Informatica Intelligent Cloud Services
のユーザー名。
最大長は255文字です。
password
String
Informatica Intelligent Cloud Services
のパスワード。
最大長は255文字です。

POST応答

要求が成功すると、ユーザーオブジェクトを返します。エラーが発生した場合にエラーオブジェクトを返します。
応答には、後続のREST API呼び出しのヘッダーに含める必要のある次の情報が含まれます。
  • icSessionId。バージョン2 REST API呼び出しのヘッダーに含まれる、REST APIセッションID。セッションIDは、30分間の非アクティブ状態の後で期限切れになります。セッションIDの期限が切れた場合は、再度ログインしてREST APIでの操作を続行します。
    セッションステータスの詳細取得については、セッションIDを参照してください。
  • serverURL。ログインを除くすべてのバージョン2のリソースURIで使用するベースURL。例えば、次のようになります。
    <serverUrl>/api/v2/job
ユーザーオブジェクトには次の属性が含まれます。
フィールド
タイプ
説明
id
String
ユーザーID。
orgId
String
ユーザーが属する組織のID。
22文字。
従来のInformatica Cloudで作成された組織では、6文字の組織IDである可能性があります。
orgUuid
String
組織の一意のID。
name
String
Informatica Intelligent Cloud Services
のユーザー名。
description
String
ユーザーの説明。
createTime
String
ユーザーアカウントの作成日時。
updateTime
String
ユーザーアカウントの最終作成日時。
createdBy
String
ユーザーアカウントを作成した
Informatica Intelligent Cloud Services
ユーザー。
updatedBy
String
ユーザーアカウントを最後に更新した
Informatica Intelligent Cloud Services
ユーザー。
sfUsername
String
Salesforceのユーザー名。ユーザーがSalesforceによって認証されるように設定されている場合に含まれます。
password
String
Salesforceのユーザーパスワード。ユーザーがSalesforceによって認証されるように設定されている場合に含まれます。
firstName
String
ユーザーアカウントの名。
lastName
String
ユーザーアカウントの姓。
title
String
ユーザーの役職。
phone
String
ユーザーの電話番号。
securityQuestion
String
セキュリティの質問。次のいずれかのコードを返します。
  • SPOUSE_MEETING_CITY
  • FIRST_JOB_CITY
  • CHILDHOOD_FRIEND
  • MOTHER_MAIDEN_NAME
  • PET_NAME
  • CHILDHOOD_NICKNAME
  • CUSTOM_QUESTION:"<question>"
securityAnswer
String
セキュリティの質問に対する答え。
roles
ユーザーに割り当てられた各ロールのロールオブジェクトを含むオブジェクト。
name
String
ロールオブジェクトに含まれます。
ロール名。次のいずれかのコードを返します。
  • サービスコンシューマ
  • Designer
  • Admin
description
String
ロールオブジェクトに含まれます。
ロールの説明。
emails
String
ユーザーがアカウントパスワードを変更する際に通知される電子メールアドレス。
timezone
String
ユーザーのタイムゾーン。タイムゾーンは夏時間を使用します。
詳細については、タイムゾーンのコードを参照してください。
serverUrl
String
ユーザーが属する組織の
Informatica Intelligent Cloud Services
のURL。最も正確なバージョン2 REST APIのリソースURIのベースとしてserverUrlを使用します。
spiUrl
String
このフィールドは適用されなくなり、非推奨になりました。
uuId
String
ユーザーの一意のID。
icSessionId
String
バージョン2 REST APIセッションの
Informatica Intelligent Cloud Services
セッションID。最も正確なバージョン2 REST API要求ヘッダーで使用します。
forceChangePassword
Boolean
初回ログイン後、ユーザーがパスワードをリセットする必要があるかどうかを決定します。次の値が含まれます。
  • True。ユーザーはパスワードをリセットする必要があります。
  • False。ユーザーはパスワードをリセットする必要がありません。

POSTの例

所属する
Informatica Intelligent Cloud Services
組織にログインするには、次の要求を使用できます。
POST https://dm-us.informaticacloud.com/ma/api/v2/user/login Content-Type: application/json Accept: application/json { "@type": "login", "username": "John@infa.com", "password": "mypassword" }
応答では、後続の呼び出しで使用するserverUrlおよびicSessionIdの値が含まれるユーザーオブジェクトが返されます。次に例を示します。
{ "id": "0101TQ03000000000007", "orgId": "0101TQ", "orgUuid": "3FNFLs1uHe2IIgTs8tRjSJ", "name": "John@infa.com", "description": "", "createTime": "2018-02-16T00:20:07.000Z", "updateTime": "2018-07-17T22:45:50.000Z", "createdBy": "System built-in user", "updatedBy": "John@infa.com", "sfUsername": null, "firstName": "John", "lastName": "Randall", "title": "IICS Admin", "password": "**********", "phone": "123-456-7899", "emails": "John@infa.com", "timezone": null, "serverUrl": "https://usw3.dm-us.informaticacloud.com/saas", "icSessionId": "1Ckv5VDHe2IICHi2hq04EF", "securityQuestion": "In what city were you born?", "securityAnswer": "********", "uuid": "a51jk7TB0IDcnWLwJdLaW2", "forceChangePassword": false, "roles": [ { "name": "Admin", "description": "Role for performing administrative tasks for an organization. Has full access to all licensed services." }, { "name": "Data Preview", "description": "Role to preview data" }, { "name": "Designer", "description": "Role for creating assets, tasks, and processes. Can configure connections, schedules, and runtime environments. Has access to the Application Integration Console." } ], }
例として上記の応答のセッションIDとサーバーURLの値を使用し、GET要求を送信してSecure Agent情報を取得するには、次の要求を使用します。
GET https://usw3.dm-us.informaticacloud.com/saas/api/v2/agent Content-Type: application/json Accept: application/json icSessionId: 1Ckv5VDHe2IICHi2hq04EF