動的プロセス定義のリストを取得
get
/ic/api/process/v1/dp-definitions
ユーザーがアクセスできる動的プロセス定義のリストを取得します。
リクエスト
サポートされているメディア・タイプ
- application/json
問合せパラメータ
- allowedAction: string
このアクションを実行できる動的プロセス定義。許容値:
[ "read", "update", "create" ] - category: string
動的プロセス定義カテゴリによるフィルタリング。 完全一致。
- categoryLike: string
パラメータが部分文字列であることを動的プロセス定義カテゴリでフィルタリングします。 文字列には、同様の戦略を表すワイルドカード文字'%'を含めることができます。 たとえば、先頭は(string%)、末尾は(%string)または次を含む(%string%)です。
- deploymentId: string
IDが属するデプロイメントによってフィルタリングします。
- firstResult: integer
結果のページ番号付け。 返される最初の結果のインデックスを指定します。
- key: string
動的プロセス定義キーによるフィルタリング。 たとえば、CMMNファイル内のIDです。 完全一致。
- keyLike: string
パラメータが部分文字列であることを動的プロセス定義キーでフィルタリングします。 文字列には、同様の戦略を表すワイルドカード文字'%'を含めることができます。 たとえば、先頭は(string%)、末尾は(%string)または次を含む(%string%)です。
- latestVersion: boolean
動的プロセス定義の最新バージョンのみを含めてください。 falseはデフォルトの動作であるため、値は真になります。
- maxResults: integer
結果のページ番号付け。 返す結果の最大数を指定します。 それ以上の結果が残っていない場合は、結果が少なくなります。
- name: string
動的プロセス名でフィルタリングします。 完全一致。
- nameLike: string
パラメータが部分文字列であることを動的プロセス定義名でフィルタリングします。 文字列には、同様の戦略を表すワイルドカード文字'%'を含めることができます。 たとえば、先頭は(string%)、末尾は(%string)または次を含む(%string%)です。
- processDefinitionId: string
動的プロセス定義IDによるフィルタリング。
- processDefinitionIdIn: array[string]
コレクション形式:
multi配列内の動的プロセス定義IDによってフィルタリングします。 - sortBy: string
結果を辞書的に並べ替えます。 有効な値は、category、key、id、name、versionおよびdeploymentIdです。 sortOrderパラメータと組み合わせて使用する必要があります。
- sortOrder: string
指定した順序で結果を並べ替えます。 値は、昇順ではasc、降順ではdescです。 sortByパラメータと組み合わせて使用する必要があります。
- version: string
動的プロセス定義バージョンによるフィルタリング。
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
操作の成功
ルート・スキーマ : ProcessDefinitions
型:
objectすべてに一致
ソースを表示
- object CommonModel
識別子:
links - object ProcessDefinitions-allOf[1]
ネストされたスキーマ : ProcessDefinition
型:
objectすべてに一致
ソースを表示
- object CommonModel
識別子:
links - object ProcessDefinition-allOf[1]
ネストされたスキーマ : ProcessDefinition-allOf[1]
型:
ソースを表示
object- category: string
プロセス定義カテゴリ
- deploymentId: string
プロセス定義デプロイメントId
- description: string
プロセス定義の要約
- formInputParam: string
入力フォームでケースを開始するために必要なパラメータ名
- formMetadataURL: string
プロセスに関連付けられたフォームURL
- id(必須): string
プロセス定義ID
- key: string
プロセス定義キー
- name: string
プロセス定義のタイトル
- resource: string
プロセス定義リソース・ファイル
- revision: string
プロセス定義デプロイメント・リビジョン
- version: integer
プロセス定義のデプロイメント・バージョン
400レスポンス
一部の問合せパラメータが有効でない場合に返されます。 たとえば、sortOrderパラメータが指定されていて、sortByが指定されていない場合などです。
401レスポンス
未認可
500レスポンス
内部サーバー・エラー
例
これらの例は、IDまたはキーによる動的プロセス定義の取得方法を示しています。
API /ic/api/process/v1/dp-definitionsをGETとともに使用して、関連付けられたIDとキーを持つデプロイされた動的プロセス定義のリストを取得します。 次に、動的プロセス定義IDまたはキーを使用して、特定の動的プロセス定義に関する詳細情報を取得します。
リクエストの送信: デプロイされた動的プロセス定義をIDで取得
curl -X GET -H 'Authorization: Bearer access_token' -H "Accept: application/json" https://example.com/ic/api/process/v1/dp-definitions/cm_DPikkv9ujdfi:2:2534説明
-
example.comは、Oracle Integrationが実行されているホストです。
リクエストの送信: キーによるデプロイされた動的プロセス定義の取得
curl -X GET -H 'Authorization: Bearer access_token' -H "Accept: application/json" https://example.com/ic/api/process/v1/dp-definitions/cm_DPikkv9ujdfi?idType=key説明
-
example.comは、Oracle Integrationが実行されているホストです。
Response:
{
"links": [
{
"href": "https://localhost:443/ic/api/process/v1/dp-definitions/cm_DPikkv9ujdfi",
"rel": "self"
},
{
"href": "https//:localhost:443/ic/api/process/v1/dp-definitions",
"rel": "parent"
},
{
"href": "https//:localhost:443/ic/api/process/v1/dp-definitions/cm_DPikkv9ujdfi/metadata",
"rel": "rel"
},
{
"href": "https//:localhost:443/ic/api/process/v1/dp-definitions/cm_DPikkv9ujdfi/interface",
"rel": "rel"
}
],
"id": "cm_DPikkv9ujdfi:2:2534",
"key": "cm_DPikkv9ujdfi",
"category": "pcs/isDP3!3.0*soa_29901635-ad30-4003-9c50-29d193d971bd",
"name": "isDP3",
"version": 2,
"resource": "DPikkv9ujdfi.cmmn",
"deploymentId": "2529",
"description": "isDP3",
"formMetadataURL": "webforms/pcs~isDP3!3.0*soa_29901635-ad30-4003-9c50-29d193d971bd~6284aad4-9bfe-4505-b66c-3ed9a49c794a~43fa020e-96e3-42b1-a420-f9dfc67c4c4e",
"formInputParam": "formArg"
}