機械翻訳について

移動先

• リクエスト
• レスポンス
• 例

動的プロセス・インスタンスの制御

put

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

動的プロセス・インスタンスに対して指定されたアクションを実行します。

中止アクションの動作は、abortTypeパラメータの設定によって異なります。 abortTypeの有効値は次のとおりです:

• self: 中止アクションが実行される現在のインスタンスのフローIDに一致するすべてのインスタンスを中断します。
• ダウンストリーム: 指定されたフローIDとその子フローIDに一致するすべてのインスタンスを中断します。
• すべて: 指定されたフローIDとその親および子フローIDに一致するすべてのインスタンスを中断します。

リクエスト

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

• application/json

パス・パラメータ

• id(required): string
  動的プロセス・インスタンスID。

本文()

更新するアクションおよび変数。

ルート・スキーマ : InstanceActionInput

型: object

ソースを表示

• action: string
  許容値: [ "abort", "close", "complete" ]

  完了、クローズ、中止
• deletions: array deletions
• variables: object VariablesMap
  許可される追加のプロパティ: additionalProperties

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

{
    "type":"object",
    "properties":{
        "variables":{
            "$ref":"#/definitions/VariablesMap"
        },
        "deletions":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "action":{
            "type":"string",
            "description":"complete, close, abort",
            "enum":[
                "abort",
                "close",
                "complete"
            ]
        }
    }
}

ネストされたスキーマ : 削除

型: array

ソースを表示

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: 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

204レスポンス

操作の成功

400レスポンス

状態遷移は許可されていません。 たとえば、動的プロセス・インスタンスがすでに完了している場合などです。

401レスポンス

未認可

403レスポンス

CMMN制限のため、動的プロセス・インスタンスを操作できません。

404レスポンス

指定したIDの動的プロセス・インスタンスが見つかりませんでした。

500レスポンス

内部サーバー・エラー

トップに戻る

例

次の例は、RESTリソースにPUTリクエストを送信してプロセス・インスタンスを更新する方法を示しています。

リクエストの送信

https://example.com/ic/api/process/<version>/dp-instances/<Id>

説明

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

例: プロセス・インスタンスとそのすべての子を中止

次の例は、PUTメソッドを使用してJSON形式でリクエストを送信する方法を示しています。

この例では、プロセス・インスタンスと、同じフローIDを持つ子のすべてのインスタンスを中断しています。

PUTリクエスト:

https://example.com/ic/api/process/v1/dp-instances/20007 

リクエスト本文:

{
                "abortType":"downstream",
                "action":"abort"
}

先頭に戻る