REST APIリファレンス > REST APIリソースクイックリファレンス > プラットフォームリソースクイックリファレンス
  

プラットフォームリソースクイックリファレンス

以下のリストには、Informatica Intelligent Cloud Services REST APIプラットフォームリソースの構文と簡単な説明が含まれています。
activityLog GET
バージョン2リソース。
モニタサービスから情報を返します。
ログイン応答から、次のいずれかのURIのベースURLとしてserverUrlを使用します。
/api/v2/activity/activityLog/<id>
/api/v2/activity/activityLog?runId=<runId>
/api/v2/activity/activityLog?taskId=<taskId>
/api/v2/activity/activityLog?offset=<offset>
/api/v2/activity/activityLog?rowLimit=<row limit>
activityLogを使用してエラーログとセッションログをサーバーからダウンロードすることもできます。
次のURIのいずれかにログイン応答からのserverUrlを使用します。
/api/v2/activity/errorLog/<id>
/api/v2/activity/activityLog/<Top_Level_Log_Entry_Id>/sessionLog?itemId=<child-log-entry-item-id>&childItemId=<child-log-entry-item-id>
activityMonitor GET
バージョン2リソース。
モニタサービスから情報を返します。
ログイン応答から、次のURIのベースURLとしてserverUrlを使用します。
/api/v2/activity/activityMonitor?details=<true|false>
agent GET
バージョン2リソース。
組織内の1つのSecure AgentまたはすべてのSecure Agentの詳細を返します。また、Secure AgentインストールトークンとチェックサムダウンロードURLを返します。
ログイン応答から、次のいずれかのURIのベースURLとしてserverUrlを使用します。
agent DELETE
バージョン2リソース。
Secure Agentを削除します。
ログイン応答から、次のURIのベースURLとしてserverUrlを使用します。
/api/v2/agent/<id>
agentservice POST
バージョン3リソース。
Secure Agentサービスを開始または停止します。
次のURIのベースURLとしてログイン応答からのbaseApiUrlを使用します。
public/core/v3/agent/service
auditlog GET
バージョン2リソース。
監査ログエントリを返します。
ログイン応答から、次のいずれかのURIのベースURLとしてserverUrlを使用します。
/api/v2/auditlog
/api/v2/auditlog?batchId=<batchId>&batchSize=<batchSize>
bundleObject GET
バージョン2リソース。
組織内の1つのバンドルの詳細またはパブリッシュまたはインストールされたすべてのバンドルの詳細を返します。
ログイン応答から、次のいずれかのURIのベースURLとしてserverUrlを使用します。
/api/v2/bundleObject
/api/v2/bundleObject/<id>
/api/v2/bundleObject/name/<name>
/api/v2/bundleObject/?published=true
/api/v2/bundleObject/?published=true&installed=false
/api/v2/bundleObject/?installed=true
/api/v2/bundleObject/?published=false&installed=true
bundleObject POST
バージョン2リソース。
サブ組織にパブリッシュされた非公開バンドルをプッシュします。
次のURIのベースURLとしてログイン応答からのserverUrlを使用します。
/api/v2/bundleObject/push/<bundleId>
bundleObjectLicense GET
バージョン2リソース。
使用可能なバンドルまたは組織にインストールされたバンドルすべての詳細を返します。
次のURIのベースURLとしてログイン応答からのserverUrlを使用します。
/api/v2/bundleObjectLicense/<bundleObjectId>
bundleObjectLicense POST
バージョン2リソース。
バンドルをインストールします。
次のURIのベースURLとしてログイン応答からのserverUrlを使用します。
/api/v2/bundleObjectLicense/
bundleObjectLicenseオブジェクトを使用して属性を定義します。次の必須属性を含めます: bundleId。
bundleObjectLicense DELETE
バージョン2リソース。
バンドルをアンインストールします。
次のURIのベースURLとしてログイン応答からのserverUrlを使用します。
/api/v2/bundleObjectLicense?bundleObjectId=<bundleId>&updateOption=<updateOption>
ChangePassword POST
バージョン3リソース。
セッションを継承したユーザーまたは指定したユーザーのパスワードを変更します。
次のURIのベースURLとしてログイン応答からのbaseApiUrlを使用します。
/public/core/v3/Users/ChangePassword
checkin POST
バージョン3リソース。
オブジェクトの最新バージョンでリポジトリを更新します。
次のURIのベースURLとしてログイン応答からのbaseApiUrlを使用します。
/public/core/v3/checkin
checkout POST
バージョン3リソース。
リポジトリからオブジェクトをチェックアウトします。
次のURIのベースURLとしてログイン応答からのbaseApiUrlを使用します。
/public/core/v3/checkout
commit GET
バージョン3リソース。
コミットの詳細を返します。
次のURIのベースURLとしてログイン応答からのbaseApiUrlを使用します。
/public/core/v3/commit/<commit hash>
commitHistory GET
バージョン3リソース。
最新のコミットが最初にリストされているソース管理オブジェクトのコミット履歴を返します。
次のURIのベースURLとしてログイン応答からのbaseApiUrlを使用します。
/public/core/v3/commitHistory<parameters>
export POST
バージョン3リソース。
エクスポートジョブを開始してエクスポートジョブIDを返します。
次のURIのベースURLとしてログイン応答からのbaseApiUrlを使用します。
/public/core/v3/export
export GET
バージョン3リソース。
エクスポートステータスまたはエクスポートパッケージを返します。
ログイン応答から、次のいずれかのURIのベースURLとしてbaseApiUrlを使用します。
fetchState POST
バージョン3リソース。
オブジェクトの状態パッケージを作成してfetchStateジョブのIDを返します。
次のURIのベースURLとしてログイン応答からのbaseApiUrlを使用します。
/public/core/v3/fetchState
fetchState GET
バージョン3リソース。
fetchStateジョブのステータスまたはオブジェクトの状態パッケージを返します。
ログイン応答から、次のいずれかのURIのベースURLとしてbaseApiUrlを使用します。
folders POST
バージョン3リソース。
デフォルトプロジェクトにフォルダを作成します。
次のURIのベースURLとしてログイン応答からのbaseApiUrlを使用します。
/public/core/v3/folders
folders PATCH
バージョン3リソース。
デフォルトプロジェクトにあるフォルダを更新します。
次のURIのベースURLとしてログイン応答からのbaseApiUrlを使用します。
/public/core/v3/folders/<folder ID>
注: デフォルトプロジェクトにないフォルダを作成または更新し、フォルダを削除するには、プロジェクトリソースを使用します。
import POST
バージョン3リソース。
インポートパッケージをアップロードまたはインポートジョブを開始します。
ログイン応答から、次のいずれかのURIのベースURLとしてbaseApiUrlを使用します。
import GET
バージョン3リソース。
インポートジョブのステータスを返します。
ログイン応答から、次のいずれかのURIのベースURLとしてbaseApiUrlを使用します。
job POST
バージョン2リソース。
タスクを開始または停止し、必要に応じてジョブステータスを指定します。
ログイン応答から、次のいずれかのURIのベースURLとしてserverUrlを使用します。
ファイル取り込みタスクでは、このリソースを使用しないでください。代わりに、ファイル取り込みとレプリケーションジョブリソースを使用します。詳細については、ジョブを参照してください。
key GET
バージョン3リソース。
組織のキーローテーション間隔の詳細を返します。
次のURIのベースURLとしてログイン応答からのbaseApiUrlを使用します。
/public/core/v3/key/rotationSettings
key PATCH
バージョン3リソース。
組織のキーローテーション間隔を変更します。
次のURIのベースURLとしてログイン応答からのbaseApiUrlを使用します。
/public/core/v3/key/rotationSettings
license GET
バージョン3リソース。
ログインされる組織または指定したサブ組織のライセンスの詳細を返します。
次のURIのベースURLとしてログイン応答からのbaseApiUrlを使用します。
/public/core/v3/license/org/<id>
license PUT
バージョン3リソース。
サブ組織のライセンス情報を更新します。
次のURIのベースURLとしてログイン応答からのbaseApiUrlを使用します。
/public/core/v3/license/org/<id>
orgLicenseAssignmentオブジェクトを使用して、ライセンス情報を更新します。
loadState POST
バージョン3リソース。
オブジェクトの状態パッケージのZIPファイルをアップロードするか、オブジェクトの状態をロードします。
ログイン応答から、次のいずれかのURIのベースURLとしてbaseApiUrlを使用します。
loadState GET
バージョン3リソース。
loadStateジョブのステータスを返します。
次のいずれかのURIで、ベースURLとしてログイン応答からのbaseApiUrlを使用し、ジョブIDを含めます。
/public/core/v3/loadState/<id>
/public/core/v3/import/<id>?expand=objects
login POST
バージョン3リソース。
組織にログインし、セッション中に実行するAPI呼び出しに使用するセッションIDを返します。
次のURLを使用します。
https://<cloud provider>-<region>.informaticacloud.com/saas/public/core/v3/login
クラウドプロバイダとリージョンの詳細については、ログインを参照してください。
要求ヘッダーにINFA-SESSION-IDを含めないでください。
ログインオブジェクトを使用して次のフィールドを含めます: ユーザー名、パスワード。
logout POST
バージョン3リソース。
組織からログアウトして要求ヘッダーに含まれたREST APIセッションを終了します。
API名を除くlogin POSTに使用される同じURLを使用します。次のURIを使用します。
https://<cloud provider>-<region>.informaticacloud.com/saas/public/core/v3/logout
login POST
バージョン2リソース。
組織にログインし、セッション中に実行するAPI呼び出しに使用するセッションIDを返します。
所属するInformatica Intelligent Cloud Servicesアカウントを使用してログインするには、次のURLを使用します。
https://<cloud provider>-<region>.informaticacloud.com/ma/api/v2/user/login
クラウドプロバイダとリージョンの詳細については、ログインしていますを参照してください。
要求ヘッダーにicSessionIdを含めないでください。
ログインオブジェクトを使用して次のフィールドを含めます: ユーザー名、パスワード。
loginSAML POST
バージョン2リソース。
SAMLシングルサインオンユーザーの場合は、組織にログインし、他のAPI呼び出しに使用できるセッションIDを返します。
組織にログインするには、次のURLを使用します。
https://<cloud provider>-<region>.informaticacloud.com/ma/api/v2/user/loginSaml
クラウドプロバイダとリージョンの詳細については、ログインしていますを参照してください。
要求ヘッダーにicSessionIdを含めないでください。
ログインオブジェクトに次の必須属性を含めます: orgId、samlToken。
loginSf POST
バージョン2リソース。
Salesforce資格証明を使用して組織にログインし、他のリソース呼び出しに使用できるセッションIDを返します。
組織にログインするには、次のURLを使用します。
https://<cloud provider>-<region>.informaticacloud.com/ma/api/v2/user/loginSf
クラウドプロバイダとリージョンの詳細については、ログインしていますを参照してください。
要求ヘッダーにicSessionIdを含めないでください。
ログインオブジェクトに次の必須属性を含めます: sfSessionId, sfServerUrl。
logout POST
バージョン2リソース。
組織からログアウトして要求ヘッダーに含まれたREST APIセッションを終了します。
ログイン応答から、次のURIのベースURLとしてserverUrlを使用します。
/api/v2/user/logout
logoutall POST
バージョン2リソース。
組織からログアウトし、組織のすべてのバージョン2 REST APIセッションを終了します。
次のURLを使用します。
https://<cloud provider>-<region>.informaticacloud.com/ma/api/v2/user/logoutall
ログアウトオブジェクトを使用して属性を定義します。次の必須属性を含めます: username、password。
要求ヘッダーにicSessionIdを含めないでください。
lookup POST
バージョン3リソース。
オブジェクトのID、名前、パス、またはタイプの属性をルックアップします。
次のURIのベースURLとしてログイン応答からのbaseApiUrlを使用します。
/public/core/v3/lookup
objects GET
バージョン3リソース。
クエリパラメータに基づいて組織のアセットのリストを返し、指定されたアセットのオブジェクトの依存関係のリストを返します。また、組織のアセット、プロジェクト、フォルダの権限の詳細、およびオブジェクトに対するアクセス権も返します。
ログイン応答から、次のいずれかのURIのベースURLとしてbaseApiUrlを使用します。
objects POST
バージョン3リソース。
アクセス制御リスト（ACL）を作成または更新します。ACLは、アセット、フォルダ、およびプロジェクトに対するユーザーまたはユーザーグループの権限を定義します。
ログイン応答から、次のいずれかのURIのベースURLとしてbaseApiUrlを使用します。
objects DELETE
バージョン3リソース。
カスタムロールを削除します。
ログイン応答から、次のいずれかのURIのベースURLとしてbaseApiUrlを使用します。
org GET
バージョン2リソース。
Informatica Intelligent Cloud Services組織または関連するサブ組織の詳細を返します。
ログイン応答から、次のいずれかのURIのベースURLとしてserverUrlを使用します。
/api/v2/org/<id>
/api/v2/org/name/<name>
org POST
バージョン2リソース。
Informatica Intelligent Cloud Services組織または関連するサブ組織の詳細を更新します。
ログイン応答から、次のURIのベースURLとしてserverUrlを使用します。
/api/v2/org/<id>
組織オブジェクトを使用して属性を定義します。
org DELETE
バージョン2リソース。
関連するサブ組織を削除します。
ログイン応答から、次のURIのベースURLとしてserverUrlを使用します。
/api/v2/org/<id>
orgs GET
バージョン3リソース。
Informatica Intelligent Cloud Services組織またはサブ組織の信頼済みIPアドレス範囲のリストを返します。
ログイン応答から、次のいずれかのURIのベースURLとしてbaseApiUrlを使用します。
/public/core/v3/Orgs/<orgId>/TrustedIP
orgs PUT
バージョン3リソース。
Informatica Intelligent Cloud Services組織またはサブ組織の信頼済みIP範囲を有効または無効にし、信頼済みIP範囲の値を追加します。また、SAMLグループおよびSAMLロールとInformatica Intelligent Cloud Servicesロールとの間のマッピングを作成または削除します。
ログイン応答から、次のいずれかのURIのベースURLとしてbaseApiUrlを使用します。
privileges GET
バージョン3リソース。
カスタムロールで使用できる権限のリストを返します。
ログイン応答から、次のいずれかのURIのベースURLとしてbaseApiUrlを使用します。
projects POST
バージョン3リソース。
プロジェクトを作成します。また、デフォルトプロジェクト以外のプロジェクトにフォルダを作成します。
ログイン応答から、次のいずれかのURIのベースURLとしてbaseApiUrlを使用します。
projects PATCH
バージョン3リソース。
プロジェクトを更新します。デフォルトプロジェクト以外のプロジェクトにあるフォルダも更新します。
ログイン応答から、次のいずれかのURIのベースURLとしてbaseApiUrlを使用します。
注: デフォルトプロジェクトにあるフォルダを作成または更新するには、フォルダリソースを使用します。
projects DELETE
バージョン3リソース。
プロジェクトまたはフォルダを削除します。
ログイン応答から、次のいずれかのURIのベースURLとしてbaseApiUrlを使用します。
pull GET
バージョン3リソース。
注: プル操作のステータスを取得するために使用していたプルGET要求は廃止されました。sourceControlAction GET要求を使用して、ソース管理操作のステータスを受け取ります。
pull POST
バージョン3リソース。
リポジトリからオブジェクトを取得して組織にロードします。
次のURIのベースURLとしてログイン応答からのbaseApiUrlを使用します。
/public/core/v3/pull
pullByCommitHash POST
バージョン3リソース。
特定のコミットによって変更されたオブジェクトをリポジトリから取得し、組織にロードします。
次のURIのベースURLとしてログイン応答からのbaseApiUrlを使用します。
/public/core/v3/pullByCommitHash
register POST
バージョン2。
Informatica Intelligent Cloud Servicesユーザーアカウントに基づいたInformatica Intelligent Cloud Servicesサブ組織を作成します。Informatica Intelligent Cloud Servicesパートナーのみの場合。
ログイン応答から、次のURIのベースURLとしてserverUrlを使用します。
/api/v2/user/register
登録オブジェクトを使用して属性を定義します。
ResetPasswordPOST
バージョン3リソース。
セッションを継承したユーザーのパスワードをリセットします。
次のURIのベースURLとしてログイン応答からのbaseApiUrlを使用します。
/public/core/v3/Users/ResetPassword
roles GET
バージョン3リソース。
組織のロールの詳細を返します。
次のURIのベースURLとしてログイン応答からのbaseApiUrlを使用します。
/public/core/v3/roles
roles POST
バージョン3リソース。
カスタムロールを作成します。
次のURIのベースURLとしてログイン応答からのbaseApiUrlを使用します。
/public/core/v3/roles
roles PUT
バージョン3リソース。
カスタムロールを更新します。
ログイン応答から、次のいずれかのURIのベースURLとしてbaseApiUrlを使用します。
roles DELETE
バージョン3リソース。
カスタムロールを削除します。
次のURIのベースURLとしてログイン応答からのbaseApiUrlを使用します。
/public/core/v3/roles/<id>
runtimeEnvironment GET
バージョン2リソース。
組織によって使用されるランタイム環境の詳細を返します。また、Secure AgentグループのSecure Agentサービスプロパティに関する詳細を取得することもできます。
ログイン応答から、次のいずれかのURIのベースURLとしてserverUrlを使用します。
runtimeEnvironment POST
バージョン2リソース。
Secure Agentグループを作成または更新します。
ログイン応答から、次のいずれかのURIのベースURLとしてserverUrlを使用します。
/api/v2/runtimeEnvironment
/api/v2/runtimeEnvironment/<id>
runtimeEnvironment PUT
バージョン2リソース。
サービスとコネクタを有効にし、Secure AgentグループのSecure Agentサービスプロパティを設定します。
ログイン応答から、次のいずれかのURIのベースURLとしてserverUrlを使用します。
runtimeEnvironment DELETE
バージョン2リソース。
Secure Agentグループを削除するか、Secure AgentグループのSecure Agentサービスプロパティ設定を削除します。
ログイン応答から、次のいずれかのURIのベースURLとしてserverUrlを使用します。
schedule GET
バージョン3リソース。
組織内の1つのスケジュールまたはすべてのスケジュールの詳細を返します。
ログイン応答から、次のいずれかのURIのベースURLとしてbaseApiUrlを使用します。
schedule POST
バージョン3リソース。
スケジュールを作成します。
次のURIのベースURLとしてログイン応答からのbaseApiUrlを使用します。
/public/core/v3/schedule
schedule PATCH
バージョン3リソース。
スケジュールを更新します。
次のURIのベースURLとしてログイン応答からのbaseApiUrlを使用します。
/public/core/v3/schedule/<id>
schedule DELETE
バージョン3リソース。
スケジュールを削除します。
次のURIのベースURLとしてログイン応答からのbaseApiUrlを使用します。
/public/core/v3/schedule/<id>
schedule GET
バージョン2リソース。
組織内の1つのスケジュールまたはすべてのスケジュールの詳細を返します。
ログイン応答から、次のいずれかのURIのベースURLとしてserverUrlを使用します。
/api/v2/schedule/<id>
/api/v2/schedule/name/<name>
schedule POST
バージョン2リソース。
スケジュールを作成または更新します。
ログイン応答から、次のURIのベースURLとしてserverUrlを使用します。
/api/v2/schedule/<id>
注: 完全なスケジュール機能を活用するには、バージョン2のscheduleリソースではなく、バージョン3のscheduleリソースを使用します。
schedule DELETE
バージョン2リソース。
スケジュールを削除します。
ログイン応答から、次のURIのベースURLとしてserverUrlを使用します。
/api/v2/schedule/<id>
securityLog GET
バージョン3リソース。
ログインアクションや権限変更などのイベントを含むセキュリティログエントリを返します。
次のURIのベースURLとしてログイン応答からのbaseApiUrlを使用します。
/public/core/v3/securityLog
serverTime GET
バージョン2リソース。
Informatica Intelligent Cloud Servicesサーバーのローカルタイムを返します。
ログイン応答から、次のURIのベースURLとしてserverUrlを使用します。
/api/v2/server/serverTime
sourceControlAction GET
バージョン3リソース。
指定されたオブジェクトのソース管理操作のステータスを返します。
ログイン応答から、次のいずれかのURIのベースURLとしてbaseApiUrlを使用します。
TagObjects POST
バージョン3リソース。
タグをアセットに割り当てます。
次のURIのベースURLとしてログイン応答からのbaseApiUrlを使用します。
/public/core/v3/TagObjects
task GET
バージョン2リソース。
指定されたタイプのタスクのリストを返します。
ログイン応答から、次のURIのベースURLとしてserverUrlを使用します。
/api/v2/task?type=<type>
undoCheckout POST
バージョン3リソース。
チェックアウトを元に戻し、オブジェクトを元の状態に戻します。
次のURIのベースURLとしてログイン応答からのbaseApiUrlを使用します。
/public/core/v3/undoCheckout
UntagObjects POST
バージョン3リソース。
アセットに割り当てられたタグを削除します。
次のURIのベースURLとしてログイン応答からのbaseApiUrlを使用します。
/public/core/v3/UntagObjects
user GET
バージョン2リソース。
組織内の1つのInformatica Intelligent Cloud Servicesユーザーアカウントまたはすべてのユーザーアカウントの詳細を返します。
ログイン応答から、次のいずれかのURIのベースURLとしてserverUrlを使用します。
/api/v2/user/<id>
/api/v2/user/name/<name>
注: 完全なユーザー管理機能を活用するには、バージョン2のuserリソースではなく、バージョン3のusersリソースを使用します。バージョン3のusersリソースは、ユーザー、ユーザーグループ、およびロールをサポートします。バージョン2のuserリソースは、ユーザーグループおよびロールをサポートせず、GET要求は組織内のすべてのユーザーを返さない場合があります。
user POST
バージョン2リソース。
Informatica Intelligent Cloud Servicesユーザーアカウントを作成または更新します。
ログイン応答から、次のURIのベースURLとしてserverUrlを使用します。
/api/v2/user/<id>
注: バージョン2 userリソースではなく、バージョン3 usersリソースを使用する事を推奨します。バージョン2 userリソースはユーザーグループまたはユーザーロールをサポートしていません。
user DELETE
バージョン2リソース。
Informatica Intelligent Cloud Servicesユーザーアカウントを削除します。
ログイン応答から、次のURIのベースURLとしてserverUrlを使用します。
/api/v2/user/<id>
userGroups GET
バージョン3リソース。
組織内のすべてのユーザーグループの詳細、または特定のユーザーグループの詳細を返します。
次のURIのベースURLとしてログイン応答からのbaseApiUrlを使用します。
/public/core/v3/userGroups
userGroups POST
バージョン3リソース。
Informatica Intelligent Cloud Servicesユーザーグループを作成します。
ログイン応答から、次のいずれかのURIのベースURLとしてbaseApiUrlを使用します。
/public/core/v3/userGroups
/public/core/v3/userGroups/<id>
userGroups PUT
バージョン3リソース。
Informatica Intelligent Cloud Servicesユーザーグループを更新します。
ログイン応答から、次のいずれかのURIのベースURLとしてbaseApiUrlを使用します。
userGroups DELETE
バージョン3リソース。
Informatica Intelligent Cloud Servicesユーザーグループを削除します。
次のURIのベースURLとしてログイン応答からのbaseApiUrlを使用します。
/public/core/v3/userGroups/<id>
users GET
バージョン3リソース。
組織内のすべてのユーザーの詳細、または特定のユーザーの詳細を返します。
ログイン応答から、次のいずれかのURIのベースURLとしてbaseApiUrlを使用します。
/public/core/v3/users
/public/core/v3/users?<parameter>
users POST
バージョン3リソース。
Informatica Intelligent Cloud Servicesユーザーアカウントを作成します。
次のURIのベースURLとしてログイン応答からのbaseApiUrlを使用します。
/public/core/v3/users
users PUT
バージョン3リソース。
ユーザーのロールとユーザーグループの割り当てを更新します。
ログイン応答から、次のいずれかのURIのベースURLとしてbaseApiUrlを使用します。
users DELETE
バージョン3リソース。
Informatica Intelligent Cloud Servicesユーザーアカウントを削除します。
次のURIのベースURLとしてログイン応答からのbaseApiUrlを使用します。
/public/core/v3/users/<id>