REST API for Oracle Integration

機械翻訳について

新しい動的プロセス・インスタンスを作成

post

/ic/api/process/v1/dp-instances

動的プロセスの新しいインスタンスを作成します。

リクエスト

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

application/json

問合せパラメータ

processDefinitionId: string

動的プロセス定義のID。
processDefinitionKey: string

動的プロセスの設計時に提供されるキー。

作成する変数。

ルート・スキーマ : CreateInstanceInput

型: object

使用可能なその他のプロパティ

ソースを表示

object additionalProperties

{
    "description":"a (key, MapItem) map. `default`is an example key",
    "properties":{
        "default":{
            "type":"object"
        }
    },
    "additionalProperties":{
        "type":"object"
    }
}

(key, MapItem)マップ。`default`はexampleキーです

ソースを表示

default: object default

{
    "description":"a (key, MapItem) map. `default`is an example key",
    "properties":{
        "default":{
            "type":"object"
        }
    },
    "additionalProperties":{
        "type":"object"
    }
}

ネストされたスキーマ : デフォルト

型: object

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

型: object

トップに戻る

レスポンス

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

application/json

201レスポンス

操作の成功

ルート・スキーマ : CreateInstanceOutput

型: object

すべてに一致

ソースを表示

object CommonModel

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

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CommonModel"
        },
        {
            "properties":{
                "id":{
                    "type":"string",
                    "description":"Instance ID of newly created instance"
                },
                "processDefinitionId":{
                    "type":"string",
                    "description":"Process definition ID"
                },
                "title":{
                    "type":"string",
                    "description":"Title of the instance"
                },
                "state":{
                    "type":"string",
                    "description":"Current satus of the instance",
                    "default":"ACTIVE",
                    "enum":[
                        "ACTIVE",
                        "COMPLETED",
                        "TERMINATED"
                    ]
                },
                "description":{
                    "type":"string",
                    "description":"Description of the process."
                }
            }
        }
    ]
}

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

型: object

識別子: links

ソースを表示

links: array links

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

ネストされたスキーマ : CreateInstanceOutput-allOf[1]

型: object

ソースを表示

description: string

プロセスの説明。
id: string

新規作成されたインスタンスのインスタンスID
processDefinitionId: string

プロセス定義ID
state: string

デフォルト値: ACTIVE

許容値: [ "ACTIVE", "COMPLETED", "TERMINATED" ]

インスタンスの現在満足度
title: string

インスタンスのタイトル

{
    "properties":{
        "id":{
            "type":"string",
            "description":"Instance ID of newly created instance"
        },
        "processDefinitionId":{
            "type":"string",
            "description":"Process definition ID"
        },
        "title":{
            "type":"string",
            "description":"Title of the instance"
        },
        "state":{
            "type":"string",
            "description":"Current satus of the instance",
            "default":"ACTIVE",
            "enum":[
                "ACTIVE",
                "COMPLETED",
                "TERMINATED"
            ]
        },
        "description":{
            "type":"string",
            "description":"Description of the process."
        }
    }
}

400レスポンス

Bodyパラメータが無効な場合に戻されます。

401レスポンス

未認可

403レスポンス

CMMN制限のため、プロセス実行をインスタンス化できません。

404レスポンス

動的プロセス定義が存在しません。

500レスポンス

内部サーバー・エラー

トップに戻る

例

これらの例では、デプロイ済動的プロセス定義から動的プロセス・インスタンスを作成する方法について説明します。まず、デプロイ済の動的プロセス定義からIDまたはキーを取得し、次に動的プロセス・インスタンスを作成します。

デプロイ済動的プロセス定義の取得

リクエストの送信:

curl -X GET -H 'Authorization: Bearer access_token' -H "Accept: application/json" https://example.com/ic/api/process/v1/dp-definitions

説明

example.comは、Oracle Integrationが実行されているホストです。

Response:

{
    "links": [
        {
            "href": "http://localhost:7001/ic/api/process/v1/dp-definitions",
            "rel": "self"
        },
        {
            "href": "http://localhost:7001/ic/api/process/v1",
            "rel": "parent"
        }
    ],
    "items": [
        {
            "links": [
                {
                    "href": "http://localhost:7001/ic/api/process/v1/dp-definitions/cm_DPfe8e5ra8is:1:5",
                    "rel": "self"
                },
                {
                    "href": "http://localhost:7001/ic/api/process/v1/dp-definitions",
                    "rel": "parent"
                },
                {
                    "href": "http://localhost:7001/ic/api/process/v1/dp-definitions/cm_DPfe8e5ra8is:1:5/metadata",
                    "rel": "rel"
                },
                {
                    "href": "http://localhost:7001/ic/api/process/v1/dp-definitions/cm_DPfe8e5ra8is:1:5/interface",
                    "rel": "rel"
                }
            ],
            "id": "cm_DPfe8e5ra8is:1:5",
            "key": "cm_DPfe8e5ra8is",
            "category": "pcs/Application123*soa_9485f556-58aa-49c9-968d-7be98f87ac13",
            "name": "NoFormDynamicProcess",
            "version": 1,
            "resource": "DPfe8e5ra8is.cmmn",
            "deploymentId": "1",
            "description": "form",
            "formMetadataURL": "webforms/pcs~Application123*soa_9485f556-58aa-49c9-968d-7be98f87ac13~11773c93-70b5-46d2-9dbb-8a94c91c0793~8a5ba429-577e-47ab-878c-cea3a1d97de9",
            "formInputParam": "formArg"
        }
    ]
}

プロセス定義IDの指定による動的プロセス・インスタンスの作成

processDefinitionId=idまたはprocessDefinitionKey=keyを使用してプロセス定義のIDまたはキーを指定することにより、動的プロセス・インスタンスを作成できます。

リクエストの送信:

たとえば、プロセス定義IDを指定すると次のようになります:

curl -u jsmith:password
 -H "Content-Type:application/json"
 -H "Accept: application/json"
 -X POST
 -d '{"formArg": {"arg1": "value1", "arg2": 2}}'
 https://example.com/ic/api/process/v1/dp-instances?processDefinitionId=cm_DPfe8e5ra8is:1:5

説明

example.comは、Oracle Integrationが実行されているホストです。

リクエスト本文で、値を持つ動的プロセス・インスタンス開始変数を指定しました。この例では、2つの属性(arg1とarg2)を持つフォームが指定されています。

{"formArg": {"arg1": "value1", "arg2": 2}}

Response:

{
    "links": [
        {
            "href": "http://example.com/ic/api/process/v1/dp-instances/7402",
            "rel": "self"
        },
        {
            "href": "http://example.com/ic/api/process/v1/dp-instances",
            "rel": "parent"
        },
        {
            "href": "http://example.com/ic/api/process/v1/dp-instances/7402/variables",
            "rel": "rel"
        },
        {
            "href": "http://example.com/ic/api/process/v1/dp-instances/7402/folders",
            "rel": "folders"
        }
    ],
    "id": "7402",
    "processDefinitionId": "cm_DPfe8e5ra8is:6:7112",
    "title": "NoFormDynamicProcess",
    "state": "ACTIVE",
    "description": null
}

プロセス定義キーの指定による動的プロセス・インスタンスの作成

リクエストの送信:

たとえば、プロセス定義キーを指定する場合は、次のようになります:

curl -u jsmith:password
 -H "Content-Type:application/json"
 -H "Accept: application/json"
 -X POST
 -d '{"formArg": {"arg1": "value1", "arg2": 2}}'
 https://example.com/ic/api/process/v1/dp-instances?processDefinitionKey=cm_DPikkv9ujdfi

説明

example.comは、Oracle Integrationが実行されているホストです。

{"formArg": {"arg1": "value1", "arg2": 2}}

Response:

{
  "links": [
    {
      "href": "https://localhost:443/ic/api/process/v1/dp-instances",
      "rel": "self"
    },
    {
      "href": "https://localhost:443/ic/api/process/v1",
      "rel": "parent"
    },
    {
      "href": "https://localhost:443/ic/api/process/v1/dp-instances/variables",
      "rel": "rel"
    },
    {
      "href": "https://localhost:443/ic/api/process/v1/dp-instances/folders",
      "rel": "folders"
    }
  ],
  "id": "2928",
  "processDefinitionId": "cm_DPikkv9ujdfi:2:2534",
  "title": "isDP3",
  "state": "ACTIVE",
  "description": "isDP3"
}

先頭に戻る