REST API for Oracle Integration

機械翻訳について

すべてのRESTエンドポイント

B2B/ドキュメントのカスタマイズ

B2B/ドキュメント・カスタマイズ・カテゴリの操作。

B2Bドキュメントのクローニング: メソッド: post
パス: /ic/api/b2b/v1/b2bdocuments/{documentId}/clone
B2Bスキーマのクローニング: メソッド: post
パス: /ic/api/b2b/v1/schemas/{schemaId}/clone
B2Bドキュメントの作成: メソッド: post
パス: /ic/api/b2b/v1/b2bdocuments
B2Bスキーマの作成: メソッド: post
パス: /ic/api/b2b/v1/schemas
SEFファイルからのB2Bスキーマの作成: メソッド: post
パス: /ic/api/b2b/v1/import
B2Bドキュメントの削除: メソッド: delete
パス: /ic/api/b2b/v1/b2bdocuments/{documentId}
B2Bスキーマの削除: メソッド: delete
パス: /ic/api/b2b/v1/schemas/{schemaId}
スキーマ実装ガイドの生成: メソッド: get
パス: /ic/api/b2b/v1/schemas/{schemaId}/guide
B2Bドキュメントの取得: メソッド: get
パス: /ic/api/b2b/v1/b2bdocuments/{documentId}
B2Bスキーマの取得: メソッド: get
パス: /ic/api/b2b/v1/schemas/{schemaId}
エレメント・コード・リストの取得: メソッド: get
パス: /ic/api/b2b/v1/schemas/{schemaId}/{elementId}/codes
B2Bドキュメント標準の取得: メソッド: get
パス: /ic/api/b2b/v1/standards
B2Bドキュメント・タイプの取得: メソッド: get
パス: /ic/api/b2b/v1/standards/{standardId}/{versionId}/{transactionId}
B2Bドキュメントの取得: メソッド: get
パス: /ic/api/b2b/v1/b2bdocuments
B2Bスキーマの取得: メソッド: get
パス: /ic/api/b2b/v1/schemas
文書トランザクションの取得: メソッド: get
パス: /ic/api/b2b/v1/standards/{standardId}/{versionId}
文書バージョンの取得: メソッド: get
パス: /ic/api/b2b/v1/standards/{standardId}
B2Bスキーマのドキュメントの取得: メソッド: get
パス: /ic/api/b2b/v1/schemas/{schemaId}/documents
B2Bドキュメントを使用した統合の取得: メソッド: get
パス: /ic/api/b2b/v1/b2bdocuments/{documentId}/integrations
B2Bドキュメントを使用した取引先の取得: メソッド: get
パス: /ic/api/b2b/v1/b2bdocuments/{documentId}/partners
B2Bドキュメントの更新: メソッド: put
パス: /ic/api/b2b/v1/b2bdocuments/{documentId}
B2Bスキーマの更新: メソッド: put
パス: /ic/api/b2b/v1/schemas/{schemaId}

B2B/Monitoring

B2B/Monitoringカテゴリの操作。

B2Bビジネス・メッセージ・ペイロードのダウンロード: メソッド: get
パス: /ic/api/b2b/v1/monitoring/businessmessages/{id}/payload/download
B2Bワイヤー・メッセージ・ペイロードのダウンロード: メソッド: get
パス: /ic/api/b2b/v1/monitoring/wiremessages/{id}/payload/download
ビジネス・メッセージ詳細の取得: メソッド: get
パス: /ic/api/b2b/v1/monitoring/businessmessages/{id}
ビジネス・メッセージの取得: メソッド: get
パス: /ic/api/b2b/v1/monitoring/businessmessages
ワイヤー・メッセージ詳細の取得: メソッド: get
パス: /ic/api/b2b/v1/monitoring/wiremessages/{id}
ワイヤー・メッセージの取得: メソッド: get
パス: /ic/api/b2b/v1/monitoring/wiremessages

B2B/取引先

B2B/Trading Partnerカテゴリの操作。

取引先の作成: メソッド: post
パス: /ic/api/b2b/v1/tpm/partners
インバウンド契約の作成: メソッド: post
パス: /ic/api/b2b/v1/tpm/partners/{tpId}/inboundagrs
アウトバウンド契約の作成: メソッド: post
パス: /ic/api/b2b/v1/tpm/partners/{tpId}/outboundagrs
B2B識別子の作成/更新: メソッド: post
パス: /ic/api/b2b/v1/tpm/partners/{tpId}/identifiers
ホスト・プロファイルの作成/更新: メソッド: post
パス: /ic/api/b2b/v1/tpm/host
取引先担当者の作成/更新: メソッド: post
パス: /ic/api/b2b/v1/tpm/partners/{tpId}/contacts
B2B識別子の削除: メソッド: delete
パス: /ic/api/b2b/v1/tpm/partners/{tpId}/identifiers/{identifierId}
ホスト識別子の削除: メソッド: delete
パス: /ic/api/b2b/v1/tpm/host/{id}
取引先の削除: メソッド: delete
パス: /ic/api/b2b/v1/tpm/partners/{tpId}
インバウンド契約の削除: メソッド: delete
パス: /ic/api/b2b/v1/tpm/partners/{tpId}/inboundagrs/{agrId}
アウトバウンド契約の削除: メソッド: delete
パス: /ic/api/b2b/v1/tpm/partners/{tpId}/outboundagrs/{agrId}
インバウンド契約のデプロイ: メソッド: post
パス: /ic/api/b2b/v1/tpm/partners/{tpId}/inboundagrs/{agrId}/deploy
アウトバウンド契約のデプロイ: メソッド: post
パス: /ic/api/b2b/v1/tpm/partners/{tpId}/outboundagrs/{agrId}/deploy
取引先のエクスポート: メソッド: get
パス: /ic/api/b2b/v1/tpm/partners/{tpId}/export
取引先のインポート: メソッド: post
パス: /ic/api/b2b/v1/tpm/partners/import
取引先の取得: メソッド: get
パス: /ic/api/b2b/v1/tpm/partners/{tpId}
インバウンド契約の取得: メソッド: get
パス: /ic/api/b2b/v1/tpm/partners/{tpId}/inboundagrs/{agrId}
アウトバウンド契約の取得: メソッド: get
パス: /ic/api/b2b/v1/tpm/partners/{tpId}/outboundagrs/{agrId}
B2B識別子の取得: メソッド: get
パス: /ic/api/b2b/v1/tpm/partners/{tpId}/identifiers
インバウンド契約の取得: メソッド: get
パス: /ic/api/b2b/v1/tpm/partners/{tpId}/inboundagrs
アウトバウンド契約の取得: メソッド: get
パス: /ic/api/b2b/v1/tpm/partners/{tpId}/outboundagrs
ホスト・プロファイルの取得: メソッド: get
パス: /ic/api/b2b/v1/tpm/host
取引先担当詳細の取得: メソッド: get
パス: /ic/api/b2b/v1/tpm/partners/{tpId}/contacts
取引先の取得: メソッド: get
パス: /ic/api/b2b/v1/tpm/partners
インバウンド契約のアンデプロイ: メソッド: post
パス: /ic/api/b2b/v1/tpm/partners/{tpId}/inboundagrs/{agrId}/undeploy
アウトバウンド契約をアンデプロイ: メソッド: post
パス: /ic/api/b2b/v1/tpm/partners/{tpId}/outboundagrs/{agrId}/undeploy
取引先の更新: メソッド: put
パス: /ic/api/b2b/v1/tpm/partners/{tpId}
インバウンド契約の更新: メソッド: put
パス: /ic/api/b2b/v1/tpm/partners/{tpId}/inboundagrs/{agrId}
アウトバウンド契約の更新: メソッド: put
パス: /ic/api/b2b/v1/tpm/partners/{tpId}/outboundagrs/{agrId}

デシジョン・モデリング・サービス

Oracle Integrationでデシジョン・モデルを管理します。

空のディシジョン・モデルを作成: メソッド: put
パス: /ic/api/process/v1/dmn/spaces/{spaceId}/decision-models/{decisionModelName}
ディシジョン・モデルとスナップショットの削除: メソッド: delete
パス: /ic/api/process/v1/dmn/spaces/{spaceId}/decision-models/{decisionModelName}
ディシジョン・モデル・スナップショットの削除: メソッド: delete
パス: /ic/api/process/v1/dmn/spaces/{spaceId}/decision-models/{decisionModelName}/versions/{decisionModelVersion}
ディシジョン・モデルのスナップショットをデプロイ: メソッド: put
パス: /ic/api/process/v1/dmn/spaces/{spaceId}/decision-models/{decisionModelName}/tags/{tagId}
ディシジョン・モデルを得る: メソッド: get
パス: /ic/api/process/v1/dmn/spaces/{spaceId}/decision-models/{decisionModelName}
スペース内のディシジョン・モデル名のリストを取得: メソッド: get
パス: /ic/api/process/v1/dmn/spaces/{spaceId}/decision-models
ディシジョン・モデルのスナップショット名のリストを取得: メソッド: get
パス: /ic/api/process/v1/dmn/spaces/{spaceId}/decision-models/{decisionModelName}/versions
ディシジョン・モデル・スナップショットのディシジョン・サービスのリストを取得: メソッド: get
パス: /ic/api/process/v1/dmn/spaces/{spaceId}/decision-models/{decisionModelName}/versions/{decisionModelVersion}/definition/decision-services
ディシジョン・モデルのランタイム・バージョンIDのリストを取得: メソッド: get
パス: /ic/api/process/v1/dmn/spaces/{spaceId}/decision-models/{decisionModelName}/tags
スペースIDのリストを取得: メソッド: get
パス: /ic/api/process/v1/dmn/spaces
新しいアクセス・トークンとリフレッシュ・トークンを取得: メソッド: post
パス: /ic/api/process/v1/auth/token/permission
スペースIDでスペースを取得: メソッド: get
パス: /ic/api/process/v1/dmn/spaces/{spaceId}
スナップショット名によるデシジョン・サービスに関する情報の取得: メソッド: get
パス: /ic/api/process/v1/dmn/spaces/{spaceId}/decision-models/{decisionModelName}/versions/{decisionModelVersion}/definition/decision-services/{decisionServiceName}
実行時バージョンIDによるデプロイ済みデシジョン・サービスの情報の取得: メソッド: get
パス: /ic/api/process/v1/dmn/spaces/{spaceId}/decision-models/{decisionModelName}/tags/{tagId}/definition/decision-services/{decisionServiceName}
ランタイム・バージョンIDに関連付けられたスナップショット名の取得: メソッド: get
パス: /ic/api/process/v1/dmn/spaces/{spaceId}/decision-models/{decisionModelName}/tags/{tagId}
ディシジョン・モデルのスナップショットをインポート: メソッド: put
パス: /ic/api/process/v1/dmn/spaces/{spaceId}/decision-models/{decisionModelName}/versions/{decisionModelVersion}
スナップショット名によるデシジョン・サービスの起動: メソッド: post
パス: /ic/api/process/v1/dmn/spaces/{spaceId}/decision-models/{decisionModelName}/versions/{decisionModelVersion}/definition/decision-services/{decisionServiceName}
実行時バージョンIDによるデプロイされたデシジョン・サービスの起動: メソッド: post
パス: /ic/api/process/v1/dmn/spaces/{spaceId}/decision-models/{decisionModelName}/tags/{tagId}/definition/decision-services/{decisionServiceName}
ディシジョン・モデル・スナップショットの読み込みまたは書き出し: メソッド: get
パス: /ic/api/process/v1/dmn/spaces/{spaceId}/decision-models/{decisionModelName}/versions/{decisionModelVersion}
アクセス・トークンをリフレッシュ: メソッド: post
パス: /ic/api/process/v1/auth/token/refresh
ディシジョン・モデルのランタイム・バージョンIDのアンデプロイ: メソッド: delete
パス: /ic/api/process/v1/dmn/spaces/{spaceId}/decision-models/{decisionModelName}/tags/{tagId}

環境

OICアプリケーションでは、任意のオリジンからの認証済アクセスは許可されません。 cross-origin resource sharing (CORS)処理のために、任意の起点に属するすべてのドメインを、許可されたサイトのリストに登録する必要があります。 CORS処理の許可済サイトのリストを取得、作成および更新します。これらのAPI機能を使用するには、管理者権限が必要です。

CORS処理に許可されるドメインのリストの作成: メソッド: post
パス: /ic/api/integration/v1/environment/corsdomains
CORS処理に許可されたドメインのリストの取得: メソッド: get
パス: /ic/api/integration/v1/environment/corsdomains
CORS処理に許可されたドメインのリストの更新: メソッド: put
パス: /ic/api/integration/v1/environment/corsdomains

Integrations/Connections

接続と接続の添付ファイルを取得、更新、削除します。接続は、統合しようとしている各構成のインスタンスに関する情報を定義します。 Oracle Integrationには、接続のベースとなるアプリケーションのタイプである事前定義済アダプタが用意されています。接続はアダプタに基づきます。

接続の削除: メソッド: delete
パス: /ic/api/integration/v1/connections/{id}
接続のメタデータのリフレッシュ: メソッド: post
パス: /ic/api/integration/v1/connections/{id}/metadata
接続の取得: メソッド: get
パス: /ic/api/integration/v1/connections/{id}
接続プロパティ添付ファイルの取得: メソッド: get
パス: /ic/api/integration/v1/connections/{id}/attachments/{connPropName}
接続の取得: メソッド: get
パス: /ic/api/integration/v1/connections
接続のテスト: メソッド: post
パス: /ic/api/integration/v1/connections/{id}/test
接続の更新: メソッド: post
パス: /ic/api/integration/v1/connections/{id}
接続プロパティ添付ファイルのアップロード: メソッド: post
パス: /ic/api/integration/v1/connections/{id}/attachments/{connPropName}
接続の検証: メソッド: post
パス: /ic/api/integration/v1/connections/{id}/validate
接続の検証とテスト: メソッド: post
パス: /ic/api/integration/v1/connections/{id}/testWithAttachments

Integrations/Integrations

統合を取得、インポート、エクスポート、更新、アクティブ化、非アクティブ化、公開および削除します。

統合のクローン: メソッド: post
パス: /ic/api/integration/v1/integrations/{id}/clone
統合バージョンの削除: メソッド: delete
パス: /ic/api/integration/v1/integrations/{id}
統合のエクスポート: メソッド: get
パス: /ic/api/integration/v1/integrations/{id}/archive
統合のインポート(追加): メソッド: post
パス: /ic/api/integration/v1/integrations/archive
統合のインポート(置換): メソッド: put
パス: /ic/api/integration/v1/integrations/archive
統合の取得: メソッド: get
パス: /ic/api/integration/v1/integrations/{id}
統合アクティブ化エラーの取得: メソッド: get
パス: /ic/api/integration/v1/integrations/{id}/activationErrors
統合アクティブ化ステータスの取得: メソッド: get
パス: /ic/api/integration/v1/integrations/{id}/activationStatus
統合の取得: メソッド: get
パス: /ic/api/integration/v1/integrations
統合の更新(アクティブ化/非アクティブ化): メソッド: post
パス: /ic/api/integration/v1/integrations/{id}

Integrations/Integrations/Scheduled統合

Integrations/Integrations/Scheduled統合カテゴリからの操作。

統合スケジュールの一時停止: メソッド: post
パス: /ic/api/integration/v1/integrations/{id}/schedule/pause
統合スケジュールの再開: メソッド: post
パス: /ic/api/integration/v1/integrations/{id}/schedule/resume
スケジュール済統合実行ステータスの取得: メソッド: get
パス: /ic/api/integration/v1/integrations/{id}/schedule/jobs/{job_id}
スケジュールされた統合を今すぐ実行: メソッド: post
パス: /ic/api/integration/v1/integrations/{id}/schedule/jobs
統合スケジュールの開始: メソッド: post
パス: /ic/api/integration/v1/integrations/{id}/schedule/start
統合スケジュールの停止: メソッド: post
パス: /ic/api/integration/v1/integrations/{id}/schedule/stop
スケジュール済統合の更新パラメータ: メソッド: patch
パス: /ic/api/integration/v1/integrations/{id}/schedule/parameters

Integrations/Libraries

ライブラリの取得、インポート、エクスポートおよび削除。

JavaScriptライブラリは、編成統合で使用するためにJavaScriptを登録および編成する手段を提供します。ライブラリ関数は統合に自動的に使用可能になります。

APIライブラリjar

APIライブラリjarファイルには、コールアウトとしての統合で使用されるJavascriptファイル/関数が含まれます。ライブラリjarファイルをダウンロードしてJS関数を変更します。その後、変更されたライブラリjarを新しいライブラリとしてインポートするか、既存のライブラリを更新できます。

APIライブラリ・メタデータ

APIライブラリをインポートしたら、APIライブラリ・メタデータXMLファイルを使用して構成します。 APIライブラリ・メタデータ・ファイルには、JS関数の分類やデータ型などの詳細が格納されます。ライブラリIdを使用して、ライブラリ・メタデータXMLファイルをインポートします。 JS関数構成詳細の一括更新のためにメタデータXMLファイルをエクスポートして、システムにインポートしなおすことができます。

ライブラリ・バージョンの削除: メソッド: delete
パス: /ic/api/integration/v1/libraries/{id}
ライブラリをエクスポート: メソッド: get
パス: /ic/api/integration/v1/libraries/{id}/archive
ライブラリ・メタデータのエクスポート: メソッド: get
パス: /ic/api/integration/v1/libraries/{id}/metadata
ライブラリ・メタデータのインポート: メソッド: post
パス: /ic/api/integration/v1/libraries/{id}/metadata
ライブラリのインポート(登録): メソッド: post
パス: /ic/api/integration/v1/libraries/archive
ライブラリの取得: メソッド: get
パス: /ic/api/integration/v1/libraries/{id}
ライブラリの取得: メソッド: get
パス: /ic/api/integration/v1/libraries
ライブラリの更新: メソッド: post
パス: /ic/api/integration/v1/libraries/{id}/archive

Integrations/Lookups

ルックアップを取得、作成、更新および削除します。

参照は再利用可能な表で、アプリケーション全体で同じアイテムを説明するために使用される様々な用語をマップします。

たとえば、あるアプリケーションは特定のコード・セットを使用して国を示すが、別のアプリケーションでは同じ国を表すために異なるコード・セットを使用します。参照は、性別コード、国籍コード、通貨コード、アプリケーションが相互に共有する必要がある情報のタイプなどのアイテムに使用できます。

ルックアップのクローンを作成: メソッド: post
パス: /ic/api/integration/v1/lookups/{name}/clone
ルックアップの作成: メソッド: post
パス: /ic/api/integration/v1/lookups
ルックアップの削除: メソッド: delete
パス: /ic/api/integration/v1/lookups/{name}
ルックアップのエクスポート: メソッド: get
パス: /ic/api/integration/v1/lookups/{name}/archive
ルックアップのインポート(追加): メソッド: post
パス: /ic/api/integration/v1/lookups/archive
ルックアップのインポート(置換): メソッド: put
パス: /ic/api/integration/v1/lookups/archive
ルックアップの取得: メソッド: get
パス: /ic/api/integration/v1/lookups/{name}
ルックアップの取得: メソッド: get
パス: /ic/api/integration/v1/lookups
ルックアップの使用方法の取得: メソッド: get
パス: /ic/api/integration/v1/lookups/{name}/usage
ルックアップの更新: メソッド: put
パス: /ic/api/integration/v1/lookups/{name}

Integrations/Monitoring

統合モニタリング・データを取得してフィルタします。

統合インスタンスの中断: メソッド: post
パス: /ic/api/integration/v1/monitoring/instances/{id}/abort
エラーが発生した統合インスタンスの破棄: メソッド: post
パス: /ic/api/integration/v1/monitoring/errors/{id}/discard
エラーが発生した統合インスタンスの破棄: メソッド: post
パス: /ic/api/integration/v1/monitoring/errors/discard
ログ・ファイルのダウンロード: メソッド: get
パス: /ic/api/integration/v1/monitoring/logs/{id}
インシデントのダウンロード(非推奨): メソッド: get
パス: /ic/api/integration/v1/monitoring/incident
データベース・パージ・ログのダウンロード: メソッド: get
パス: /ic/api/integration/v1/monitoring/logs/oicpurgelogs
Incident(Deprecated)のレポート: メソッド: post
パス: /ic/api/integration/v1/monitoring/reportIncident
失敗したスケジュール済統合実行の再発行: メソッド: post
パス: /ic/api/integration/v1/monitoring/runs/{id}/resubmit
エラーが発生した統合インスタンスの再発行: メソッド: post
パス: /ic/api/integration/v1/monitoring/errors/{id}/resubmit
エラーが発生した統合インスタンスの再発行: メソッド: post
パス: /ic/api/integration/v1/monitoring/errors/resubmit
アクティビティ・ストリーム・メッセージの取得(非推奨): メソッド: get
パス: /ic/api/integration/v1/monitoring/integrationActivityStream
エラー・リカバリ・ジョブの取得: メソッド: get
パス: /ic/api/integration/v1/monitoring/errors/recoveryJobs/{id}
エラーが発生した統合インスタンスの取得: メソッド: get
パス: /ic/api/integration/v1/monitoring/errors/{id}
統合インスタンスの取得: メソッド: get
パス: /ic/api/integration/v1/monitoring/instances/{id}
監査レコードの取得: メソッド: get
パス: /ic/api/integration/v1/monitoring/auditRecords
エラー・リカバリ・ジョブの取得: メソッド: get
パス: /ic/api/integration/v1/monitoring/errors/recoveryJobs
エラーが発生したインスタンスの取得: メソッド: get
パス: /ic/api/integration/v1/monitoring/errors
履歴トラッキング・メトリックの取得: メソッド: get
パス: /ic/api/integration/v1/monitoring/history
統合インスタンス・アクティビティ・ストリームの取得: メソッド: get
パス: /ic/api/integration/v1/monitoring/instances/{id}/activityStream
統合インスタンスの取得: メソッド: get
パス: /ic/api/integration/v1/monitoring/instances
メッセージ件数要約の取得: メソッド: get
パス: /ic/api/integration/v1/monitoring/integrations/messages/summary
統合のモニタリング・データの取得: メソッド: get
パス: /ic/api/integration/v1/monitoring/integrations/{id}
統合のモニタリング・データの取得: メソッド: get
パス: /ic/api/integration/v1/monitoring/integrations
エージェント・グループのステータスの取得: メソッド: get
パス: /ic/api/integration/v1/monitoring/agentgroups
エージェント・グループ内のエージェントのステータスの取得: メソッド: get
パス: /ic/api/integration/v1/monitoring/agentgroups/{id}/agents
エージェントのステータスの取得: メソッド: get
パス: /ic/api/integration/v1/monitoring/agentgroups/{id}/agents/{key}
エージェント・グループのステータスの取得: メソッド: get
パス: /ic/api/integration/v1/monitoring/agentgroups/{id}
アクティビティ・ストリームの取得(非推奨): メソッド: get
パス: /ic/api/integration/v1/monitoring/activityStream

Integrations/Packages

パッケージの取得、更新および削除。パッケージを使用して、1つ以上の統合を1つの構造にグループ化します。パッケージを使用すると、統合のグループをOracle Integrationと簡単にインポートおよびエクスポートできます。パッケージは任意で使用します。つまり、統合をパッケージに含める必要はありません。

パッケージのクローニング: メソッド: post
パス: /ic/api/integration/v1/packages/{packagename}/clone
パッケージの削除: メソッド: delete
パス: /ic/api/integration/v1/packages/{packagename}
パッケージのエクスポート: メソッド: get
パス: /ic/api/integration/v1/packages/{packagename}/archive
サンプル・パッケージのインポート: メソッド: post
パス: /ic/api/integration/v1/packages/loadSamples
パッケージのインポート(追加): メソッド: post
パス: /ic/api/integration/v1/packages/archive
パッケージのインポート(置換): メソッド: put
パス: /ic/api/integration/v1/packages/archive
パッケージの取得: メソッド: get
パス: /ic/api/integration/v1/packages/{packagename}
パッケージの取得: メソッド: get
パス: /ic/api/integration/v1/packages
パッケージ依存関係の更新: メソッド: post
パス: /ic/api/integration/v1/packages/{packagename}

プロセス/デプロイされたプロジェクト

デプロイ済プロジェクトを管理します。

プロジェクトのデプロイ: メソッド: post
パス: /ic/api/process/v1/targets/{targetId}
デプロイされたプロジェクト・リビジョンを取得: メソッド: get
パス: /ic/api/process/v1/targets/{targetId}/projects/{projectId}/revisions/{revision}
デプロイ済プロジェクト改訂のエンドポイント構成の取得: メソッド: get
パス: /ic/api/process/v1/targets/{targetId}/projects/{projectId}/revisions/{revision}/endpoints
プロジェクトのリビジョンを取得: メソッド: get
パス: /ic/api/process/v1/targets/{targetId}/projects/{projectId}/revisions
リビジョンに関する互換性レポートの取得: メソッド: get
パス: /ic/api/process/v1/targets/{targetId}/projects/{projectId}/revisions/{revision}/compatibility-report
プロジェクト・リビジョンのアンデプロイ: メソッド: delete
パス: /ic/api/process/v1/targets/{targetId}/projects/{projectId}/revisions/{revision}
デプロイされたプロジェクトのリビジョンを更新: メソッド: patch
パス: /ic/api/process/v1/targets/{targetId}/projects/{projectId}/revisions/{revision}

プロセス/Designtimeプロジェクト

プロジェクトのライフサイクル・オペレーションの作成と管理。

プロジェクトのコピー: メソッド: post
パス: /ic/api/process/v1/spaces/{spaceId}/projects/{projectId}/clone
DesignTimeプロセスの作成: メソッド: post
パス: /ic/api/process/v1/spaces/{spaceId}/projects/{projectId}/processes
スナップショットの作成: メソッド: post
パス: /ic/api/process/v1/spaces/{spaceId}/projects/{projectId}/snapshots
新規プロジェクトを作成またはインポート: メソッド: post
パス: /ic/api/process/v1/spaces/{spaceId}/projects
DesignTimeプロセスを削除: メソッド: delete
パス: /ic/api/process/v1/spaces/{spaceId}/projects/{projectId}/processes/{processId}
プロジェクトの削除: メソッド: delete
パス: /ic/api/process/v1/spaces/{spaceId}/projects/{projectId}
スナップショットの削除: メソッド: delete
パス: /ic/api/process/v1/spaces/{spaceId}/projects/{projectId}/snapshots/{snapshotId}
プロジェクトの最新の公開バージョンをデプロイ: メソッド: post
パス: /ic/api/process/v1/spaces/{spaceId}/projects/{projectId}/deploy
最新バージョンのプロジェクトをデプロイ: メソッド: post
パス: /ic/api/process/v1/spaces/{spaceId}/projects/{projectId}/snapshots/{snapshotId}/deploy
スナップショットのエクスポート: メソッド: get
パス: /ic/api/process/v1/spaces/{spaceId}/projects/{projectId}/snapshots/{snapshotId}/exp
プロジェクトのエクスポート: メソッド: get
パス: /ic/api/process/v1/spaces/{spaceId}/projects/{projectId}/exp
プロセスのレポートの生成およびエクスポート: メソッド: put
パス: /ic/api/process/v1/spaces/{spaceId}/projects/{projectId}/processes/{processId}/report
すべてのプロセスのレポートの生成およびエクスポート: メソッド: put
パス: /ic/api/process/v1/spaces/{spaceId}/projects/{projectId}/report
IDによるDesignTimeプロセスの取得: メソッド: get
パス: /ic/api/process/v1/spaces/{spaceId}/projects/{projectId}/processes/{processId}
IDでプロジェクトを取得: メソッド: get
パス: /ic/api/process/v1/spaces/{spaceId}/projects/{projectId}
IDでスナップショットを取得: メソッド: get
パス: /ic/api/process/v1/spaces/{spaceId}/projects/{projectId}/snapshots/{snapshotId}
プロセスの取得: メソッド: get
パス: /ic/api/process/v1/spaces/{spaceId}/projects/{projectId}/processes
プロジェクトの取得: メソッド: get
パス: /ic/api/process/v1/spaces/{spaceId}/projects
プロジェクトのスナップショットを取得: メソッド: get
パス: /ic/api/process/v1/spaces/{spaceId}/projects/{projectId}/snapshots
プロジェクトの説明を更新: メソッド: put
パス: /ic/api/process/v1/spaces/{spaceId}/projects/{projectId}

プロセス/動的プロセス定義

動的プロセス定義を管理します。

IDによる動的プロセス定義の取得: メソッド: get
パス: /ic/api/process/v1/dp-definitions/{id}
動的プロセス定義のリストを取得: メソッド: get
パス: /ic/api/process/v1/dp-definitions
動的プロセス定義インタフェースを取得: メソッド: get
パス: /ic/api/process/v1/dp-definitions/{id}/interface
動的プロセス定義メタデータを取得: メソッド: get
パス: /ic/api/process/v1/dp-definitions/{id}/metadata

プロセス/動的プロセスの実行

動的なプロセス実行を管理します。動的プロセス実行は、プロセス、ヒューマン・タスク、ステージ、マイルストンなど、動的プロセス内のすべてのアクティビティです。各アクティビティは実行IDで識別されます。

動的プロセス実行の制御: メソッド: put
パス: /ic/api/process/v1/dp-executions/{id}
動的プロセス実行のリストを取得: メソッド: get
パス: /ic/api/process/v1/dp-executions
動的プロセス実行詳細の取得: メソッド: get
パス: /ic/api/process/v1/dp-executions/{id}
フォルダの詳細を取得: メソッド: get
パス: /ic/api/process/v1/dp-instances/{id}/folders/{folderId}

プロセス/動的プロセス・インスタンス

動的プロセス・インスタンスを管理します。

動的プロセス・インスタンスの制御: メソッド: put
パス: /ic/api/process/v1/dp-instances/{id}
新しい動的プロセス・インスタンスを作成: メソッド: post
パス: /ic/api/process/v1/dp-instances
IDで動的プロセス・インスタンスを取得: メソッド: get
パス: /ic/api/process/v1/dp-instances/{id}
動的プロセス・インスタンスのリストを取得: メソッド: get
パス: /ic/api/process/v1/dp-instances
動的プロセス・インスタンスに関連付けられているフォルダのリストを取得: メソッド: get
パス: /ic/api/process/v1/dp-instances/{id}/folders
変数データの取得: メソッド: get
パス: /ic/api/process/v1/dp-instances/{id}/variables/{variableName}
動的プロセス・インスタンスの変数の取得: メソッド: get
パス: /ic/api/process/v1/dp-instances/{id}/variables

プロセス/動的プロセス・リソース

動的プロセス・リソースを管理します。

動的プロセス・リソースの取得: メソッド: get
パス: /ic/api/process/v1/dp-resources/{name}
動的プロセス・リソースのリストの取得: メソッド: get
パス: /ic/api/process/v1/dp-resources

プロセス/動的プロセス・ロール

動的プロセス・ロールを管理します。

ロールの権限を追加、更新、または削除: メソッド: post
パス: /ic/api/process/v1/dp-roles/{id}/permissions
ロールのメンバーの追加、更新、または削除: メソッド: post
パス: /ic/api/process/v1/dp-roles/{id}/members
新しい動的プロセス・ロールを作成: メソッド: post
パス: /ic/api/process/v1/dp-roles
動的プロセス・ロールを削除: メソッド: delete
パス: /ic/api/process/v1/dp-roles/{id}
動的プロセス・ロールを取得: メソッド: get
パス: /ic/api/process/v1/dp-roles/{id}
動的プロセス・ロールの権限を取得: メソッド: get
パス: /ic/api/process/v1/dp-roles/{id}/permissions
動的プロセス・ロールのメンバーを取得: メソッド: get
パス: /ic/api/process/v1/dp-roles/{id}/members
動的プロセス・ロールの一覧表示: メソッド: get
パス: /ic/api/process/v1/dp-roles
動的プロセス・ロールを更新: メソッド: put
パス: /ic/api/process/v1/dp-roles/{id}

Process/Identities

アカウントの管理

ロールへのメンバーの追加/ロールからのメンバーの削除: メソッド: post
パス: /ic/api/process/v1/identities/roles/{roleid}/members
アプリケーション・ロールの削除: メソッド: delete
パス: /ic/api/process/v1/identities/roles/{roleid}
グループの取得: メソッド: get
パス: /ic/api/process/v1/identities/groups/{groupid}
ログイン・ユーザーの取得: メソッド: get
パス: /ic/api/process/v1/identities/loggedInUser
ロールの取得: メソッド: get
パス: /ic/api/process/v1/identities/roles/{roleid}
ユーザーの取得: メソッド: get
パス: /ic/api/process/v1/identities/users/{userid}
すべてのユーザー、グループ、またはロールを取得: メソッド: get
パス: /ic/api/process/v1/identities/{scope}
IDの取得: メソッド: get
パス: /ic/api/process/v1/identities
ロールのメンバーの取得: メソッド: get
パス: /ic/api/process/v1/identities/roles/{roleid}/members
グループ内のユーザーの取得: メソッド: get
パス: /ic/api/process/v1/identities/groups/{groupid}/users

Process/Preferences

ユーザー・プリファレンスおよびアプリケーション・プリファレンスを管理します。ユーザー・プリファレンスは、個別のプリファレンスであり、通知のタイムゾーン、タスク・リストのサイズとグループ化、および不在時のタスク委任などが含まれます。ユーザーは自分のプリファレンスを設定できます。管理者は、アプリケーション・プリファレンスを追加で設定および削除できます。アプリケーション・プリファレンスは管理者のみが設定できます。

ログイン・ユーザーのユーザー・プリファレンスおよびアプリケーション・プリファレンスの削除: メソッド: delete
パス: /ic/api/process/v1/preferences
ユーザーのユーザー・プリファレンスの削除: メソッド: delete
パス: /ic/api/process/v1/preferences/bulk
ログイン・ユーザーのユーザー・プリファレンスおよびアプリケーション・プリファレンスの取得: メソッド: get
パス: /ic/api/process/v1/preferences
ログイン・ユーザーのプリファレンスの付与または取消: メソッド: post
パス: /ic/api/process/v1/preferences
ユーザーのプリファレンスの付与または取消: メソッド: put
パス: /ic/api/process/v1/preferences/bulk

プロセス/プロセス・アナリティクス

AnalyticsQueriesを取得します。

Analytics問合せを作成または実行: メソッド: post
パス: /ic/api/process/v1/analyticsqueries
ビジネス問合せを削除: メソッド: delete
パス: /ic/api/process/v1/analyticsqueries/{businessQueryId}
アナリティクス問合せ定義または実行結果の取得: メソッド: get
パス: /ic/api/process/v1/analyticsqueries/{businessQueryId}
データ・ソースの使用可能な列の取得: メソッド: get
パス: /ic/api/process/v1/analyticsqueries-datasources/{dataSource}/columns
データ・ソースの取得: メソッド: get
パス: /ic/api/process/v1/analyticsqueries-datasources
DataObject名の取得: メソッド: get
パス: /ic/api/process/v1/analyticsdataobjects
DataObjectのデータの取得: メソッド: get
パス: /ic/api/process/v1/analyticsdataobjects/{dataObjectName}/data
DataObjectのメタデータの取得: メソッド: get
パス: /ic/api/process/v1/analyticsdataobjects/{dataObjectName}
サポートされる集計操作の取得: メソッド: get
パス: /ic/api/process/v1/analyticsqueries-aggregateoperations
サポートされる比較演算子の取得: メソッド: get
パス: /ic/api/process/v1/analyticsqueries-comparisonoperators
DataSource列の戻りリンク: メソッド: get
パス: /ic/api/process/v1/analyticsqueries-datasources/{dataSource}
OOTBとビジネス問合せを返します: メソッド: get
パス: /ic/api/process/v1/analyticsqueries
ビジネス問合せの更新: メソッド: put
パス: /ic/api/process/v1/analyticsqueries/{businessQueryId}

プロセス/プロセス定義

プロセス定義の取得

Webフォームのフォーム・インスタンスの取得: メソッド: get
パス: /ic/api/process/v1/process-definitions/{processDefId}/{serviceName}/webform
管理フォルダ・メタデータを取得: メソッド: get
パス: /ic/api/process/v1/process-definitions/{processDefId}/documents/managed-folders/{folderName}
着信フォルダ・メタデータを取得: メソッド: get
パス: /ic/api/process/v1/process-definitions/{processDefId}/documents/incoming-folders/{folderName}
Conversationメタデータを取得: メソッド: get
パス: /ic/api/process/v1/process-definitions/{processDefId}/conversations/{conversationName}
会話を取得: メソッド: get
パス: /ic/api/process/v1/process-definitions/{processDefId}/conversations
ドキュメント・メタデータの取得: メソッド: get
パス: /ic/api/process/v1/process-definitions/{processDefId}/documents
受信ドキュメント・メタデータの取得: メソッド: get
パス: /ic/api/process/v1/process-definitions/{processDefId}/documents/incoming-documents
ドキュメントの受信メタデータを取得: メソッド: get
パス: /ic/api/process/v1/process-definitions/{processDefId}/documents/incoming-documents/{documentName}
着信フォルダのメタデータを取得: メソッド: get
パス: /ic/api/process/v1/process-definitions/{processDefId}/documents/incoming-folders
プロセス定義の取得: メソッド: get
パス: /ic/api/process/v1/process-definitions
プロセス・メタデータの取得: メソッド: get
パス: /ic/api/process/v1/process-definitions/{processDefId}/process-metadata
管理フォルダ・メタデータを取得: メソッド: get
パス: /ic/api/process/v1/process-definitions/{processDefId}/documents/managed-folders
起動フォルダ名の取得: メソッド: get
パス: /ic/api/process/v1/process-definitions/{processDefId}/startFolderName
プロセス定義のインタフェース・タイプの更新(非推奨): メソッド: put
パス: /ic/api/process/v1/process-definitions

プロセス/プロセス・インスタンス

プロセス・インスタンスに関する情報を作成および取得します。

プロセスに添付ファイルを追加: メソッド: post
パス: /ic/api/process/v1/processes/{processId}/attachments
プロセスにコメントを追加: メソッド: post
パス: /ic/api/process/v1/processes/{processId}/comments
プロセス・インスタンスの作成: メソッド: post
パス: /ic/api/process/v1/processes
プロセス添付ファイルの削除: メソッド: delete
パス: /ic/api/process/v1/processes/{processId}/attachments/{attachmentId}
プロセス・インスタンスのフォルトの取得: メソッド: get
パス: /ic/api/process/v1/processes/{processId}/faults
インスタンスのリストに対してアクションを実行: メソッド: put
パス: /ic/api/process/v1/processes
プロセス・インスタンスの対話の取得: メソッド: get
パス: /ic/api/process/v1/processes/{processId}/conversations/{conversationId}
プロセス・アタッチメントをストリームとして取得: メソッド: get
パス: /ic/api/process/v1/processes/{processId}/attachments/{attachmentName}/stream
プロセス・インスタンスの取得: メソッド: get
パス: /ic/api/process/v1/processes/{processId}
ケースIDでプロセス・インスタンスを取得: メソッド: get
パス: /ic/api/process/v1/processes/dynamic-process/{executionId}
プロセス・インスタンスのアクティビティ・フローの取得: メソッド: get
パス: /ic/api/process/v1/processes/{processId}/activityflows
プロセス・インスタンスの対話(複数)の取得: メソッド: get
パス: /ic/api/process/v1/processes/{processId}/conversations
オープン・アクティビティIDによるデータ・オブジェクトの取得: メソッド: get
パス: /ic/api/process/v1/processes/{processId}/activities/{activityId}/dataobjects
プロセス・インスタンスのデータ・オブジェクトの取得: メソッド: get
パス: /ic/api/process/v1/processes/{processId}/dataobjects
ユーザーのインスタンス・メトリックの取得: メソッド: get
パス: /ic/api/process/v1/processes/instance-metrics
プロセス・インスタンスのオープン・アクティビティの取得: メソッド: get
パス: /ic/api/process/v1/processes/{processId}/activities
承認結果を取得: メソッド: get
パス: /ic/api/process/v1/processes/{processId}/approval
プロセス・インスタンスの添付ファイル・リストを取得: メソッド: get
パス: /ic/api/process/v1/processes/{processId}/attachments
プロセス・インスタンスの監査ダイアグラムの取得: メソッド: get
パス: /ic/api/process/v1/processes/{processId}/audit
指定した監査問合せIDの監査インスタンス・ペイロード・ドキュメントの取得: メソッド: get
パス: /ic/api/process/v1/processes/{processId}/audit/{queryId}/payload
プロセス・インスタンスのコメント・リストを取得: メソッド: get
パス: /ic/api/process/v1/processes/{processId}/comments
プロセス・インスタンスのDOCSフォルダの詳細を取得: メソッド: get
パス: /ic/api/process/v1/processes/{processId}/folders/{folderId}
プロセス・インスタンスのDOCフォルダのリストを取得: メソッド: get
パス: /ic/api/process/v1/processes/{processId}/folders
プロセス・インスタンス・リストの取得: メソッド: get
パス: /ic/api/process/v1/processes
プロセス状態の更新: メソッド: put
パス: /ic/api/process/v1/processes/{processId}

プロセス/QuickStartアプリケーション

QuickStartアプリケーションの作成と管理。

QuickStartアプリを削除: メソッド: delete
パス: /ic/api/process/v1/quickStartApps/{quickStartAppId}
QuickStartアプリケーションをIDで取得: メソッド: get
パス: /ic/api/process/v1/quickStartApps/{quickStartAppId}
QuickStartアプリを取得: メソッド: get
パス: /ic/api/process/v1/quickStartApps

Process/Spaces

スペースを作成および管理します。

スペースにユーザーを追加: メソッド: put
パス: /ic/api/process/v1/spaces/{spaceId}/permissions/{principal}
スペースの作成: メソッド: post
パス: /ic/api/process/v1/spaces
スペースを削除: メソッド: delete
パス: /ic/api/process/v1/spaces/{spaceId}
スペースに割り当てられた権限の一覧表示: メソッド: get
パス: /ic/api/process/v1/spaces/{spaceId}/permissions
スペースからのユーザーの削除: メソッド: delete
パス: /ic/api/process/v1/spaces/{spaceId}/permissions/{principal}
IDでスペースを取得: メソッド: get
パス: /ic/api/process/v1/spaces/{spaceId}
アクセス許可の詳細の取得: メソッド: get
パス: /ic/api/process/v1/spaces/{spaceId}/permissions/{principal}
スペースの取得: メソッド: get
パス: /ic/api/process/v1/spaces

Process/Tasks

タスク・リストを取得します。タスクを取得、作成、更新および削除します。

タスクの添付ファイルの追加: メソッド: post
パス: /ic/api/process/v1/tasks/{id}/attachments
タスク・コメントの追加: メソッド: post
パス: /ic/api/process/v1/tasks/{id}/comments
タスクの添付ファイルの削除: メソッド: delete
パス: /ic/api/process/v1/tasks/{id}/attachments/{attachmentName}
タスクに対するアクションの実行: メソッド: put
パス: /ic/api/process/v1/tasks/{id}
タスクに関する一括アクションの実行: メソッド: put
パス: /ic/api/process/v1/tasks
カスタム・タスク・リストの取得: メソッド: get
パス: /ic/api/process/v1/tasks/views/{viewname}
タスクの会話のリストを取得: メソッド: get
パス: /ic/api/process/v1/tasks/{id}/conversations
タスクの取得: メソッド: get
パス: /ic/api/process/v1/tasks/{id}
ストリームとしてのタスクの添付ファイルの取得: メソッド: get
パス: /ic/api/process/v1/tasks/{id}/attachments/{attachmentName}/stream
名前によるタスクの添付ファイルの取得: メソッド: get
パス: /ic/api/process/v1/tasks/{id}/attachments/{attachmentName}
会話IDによるタスク会話の取得: メソッド: get
パス: /ic/api/process/v1/tasks/{id}/conversations/{conversationId}
タスク・リストの取得: メソッド: get
パス: /ic/api/process/v1/tasks
カスタム・タスク・リストの取得: メソッド: get
パス: /ic/api/process/v1/tasks/views
タスクのフォルダIDでDOCのフォルダの詳細を取得: メソッド: get
パス: /ic/api/process/v1/tasks/{id}/folders/{folderId}
タスクのDOCフォルダ詳細の取得: メソッド: get
パス: /ic/api/process/v1/tasks/{id}/folders
タスクの添付ファイルの取得: メソッド: get
パス: /ic/api/process/v1/tasks/{id}/attachments
タスク・コメントの取得: メソッド: get
パス: /ic/api/process/v1/tasks/{id}/comments
タスクの履歴の取得: メソッド: get
パス: /ic/api/process/v1/tasks/{id}/history
ユーザーのタスク・メトリックの取得: メソッド: get
パス: /ic/api/process/v1/tasks/task-metrics
タスク・ペイロードの取得: メソッド: get
パス: /ic/api/process/v1/tasks/{id}/payload
タスク・ペイロードの更新: メソッド: post
パス: /ic/api/process/v1/tasks/{id}/payload