REST API for Oracle Integration

機械翻訳について

IDによる動的プロセス定義の取得

get

/ic/api/process/v1/dp-definitions/{id}

指定した動的プロセス定義IDを持つ動的プロセス定義を取得します。

リクエスト

サポートされているメディア・タイプ

application/json

パス・パラメータ

id(required): string

プロセス定義ID。

問合せパラメータ

idType: string

IDのタイプ。プロセス定義Idまたはプロセス定義キーを使用します。

デフォルト値: id

許容値: [ "id", "key" ]

トップに戻る

レスポンス

サポートされているメディア・タイプ

application/json

200レスポンス

操作の成功

ルート・スキーマ : ProcessDefinition

型: object

すべてに一致

ソースを表示

object CommonModel

識別子: links
object ProcessDefinition-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CommonModel"
        },
        {
            "properties":{
                "id":{
                    "type":"string",
                    "description":"Process definition ID"
                },
                "key":{
                    "type":"string",
                    "description":"Process definition key"
                },
                "category":{
                    "type":"string",
                    "description":"Process definition category"
                },
                "name":{
                    "type":"string",
                    "description":"Process definition title"
                },
                "version":{
                    "type":"integer",
                    "description":"Process definition deployment version"
                },
                "revision":{
                    "type":"string",
                    "description":"Process definition deployment revision"
                },
                "resource":{
                    "type":"string",
                    "description":"Process definition resource file"
                },
                "deploymentId":{
                    "type":"string",
                    "description":"Process definition deployment Id"
                },
                "description":{
                    "type":"string",
                    "description":"Process definition summary"
                },
                "formMetadataURL":{
                    "type":"string",
                    "description":"Form URL associated with the process"
                },
                "formInputParam":{
                    "type":"string",
                    "description":"Input Parameter name required to start the case with a form"
                }
            },
            "required":[
                "id"
            ]
        }
    ]
}

ネストされたスキーマ : CommonModel

型: object

識別子: links

ソースを表示

links: array links

{
    "type":"object",
    "discriminator":"links",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

ネストされたスキーマ : 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

プロセス定義のデプロイメント・バージョン

{
    "properties":{
        "id":{
            "type":"string",
            "description":"Process definition ID"
        },
        "key":{
            "type":"string",
            "description":"Process definition key"
        },
        "category":{
            "type":"string",
            "description":"Process definition category"
        },
        "name":{
            "type":"string",
            "description":"Process definition title"
        },
        "version":{
            "type":"integer",
            "description":"Process definition deployment version"
        },
        "revision":{
            "type":"string",
            "description":"Process definition deployment revision"
        },
        "resource":{
            "type":"string",
            "description":"Process definition resource file"
        },
        "deploymentId":{
            "type":"string",
            "description":"Process definition deployment Id"
        },
        "description":{
            "type":"string",
            "description":"Process definition summary"
        },
        "formMetadataURL":{
            "type":"string",
            "description":"Form URL associated with the process"
        },
        "formInputParam":{
            "type":"string",
            "description":"Input Parameter name required to start the case with a form"
        }
    },
    "required":[
        "id"
    ]
}

401レスポンス

未認可

404レスポンス

指定したIDまたはキーを持つ動的プロセス定義が存在しません。

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"
}

先頭に戻る