機械翻訳について

移動先

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

プロセス・インスタンスの作成

post

/process/api/v1/instances

プロセスの新しいインスタンスを作成します。 次のいずれかを使用してインスタンスを作成できます: processDefinitionId、processDefinitionKeyおよびapplicationNameとapplicationVersionおよびprocessName。 applicationName、applicationVersionおよびprocessNameで作成する場合、applicationVersionはオプションです。 applicationVersionが指定されていない場合は、デフォルト・バージョンが選択されてインスタンスが作成されます。

リクエスト

ヘッダー・パラメータ

• oci-original-url:
  顧客がリクエストした実際のエンドポイント

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

• application/json

リクエスト本文 - application/json ()

ルート・スキーマ: schema

型: object

プロセス・インスタンスを作成するには、パラメータとデータを指定します。 paramsオブジェクトの場合、次のいずれかを指定: applicationVersionとともに、processDefId、processDefKeyまたはapplicationNameおよびprocessName。 createWithがidの場合は、processDefinitionIdのみを指定します。 createWithがキーの場合は、processDefinitionKeyのみを指定します。 createWithがappの場合は、applicationName、processNameおよびapplicationVersionを指定します。 applicationVersionパラメータはオプションで、指定しない場合、デフォルト・バージョンとみなされます。

ソースを表示

• dataObject: object dataObject
  許可される追加のプロパティ: additionalProperties
• default: object default
• params: object params

{
    "description":"To create a process instance, provide params and data. For params object, provide one of the following: processDefId, or processDefKey, or applicationName and processName along with  applicationVersion. If createWith is id, provide only processDefinitionId. If createWith is key, provide only processDefinitionKey. If createWith is app, provide applicationName, processName, and applicationVersion. The applicationVersion parameter is optional, and if it is not provided then the default version is considered.\n",
    "properties":{
        "default":{
            "type":"object"
        },
        "params":{
            "type":"object",
            "properties":{
                "processDefinitionId":{
                    "type":"string",
                    "description":"Process definition ID of the process to initiate instance"
                },
                "processDefinitionKey":{
                    "type":"string",
                    "description":"Process definition ID of the process to initiate instance"
                },
                "applicationName":{
                    "type":"string",
                    "description":"Name of the active application that contains the process to create the instance"
                },
                "applicationVersion":{
                    "type":"string",
                    "description":"Version of the active application that contains the process to create the instance. If this is empty,\nthe default version is used\n"
                },
                "processName":{
                    "type":"string",
                    "description":"The name of the process to create the instance"
                }
            }
        },
        "dataObject":{
            "type":"object",
            "additionalProperties":{
                "type":"object"
            }
        }
    }
}

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

型: object

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

ソースを表示

• object additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object"
    }
}

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

型: object

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

型: object

ソースを表示

• applicationName: string
  インスタンスを作成するプロセスを含むアクティブなアプリケーションの名前
• applicationVersion: string
  インスタンスを作成するプロセスを含むアクティブ・アプリケーションのバージョン。 これが空の場合、デフォルトのバージョンが使用されます
• processDefinitionId: string
  インスタンスを開始するプロセスのプロセス定義ID
• processDefinitionKey: string
  インスタンスを開始するプロセスのプロセス定義ID
• processName: string
  インスタンスを作成するプロセスの名前

{
    "type":"object",
    "properties":{
        "processDefinitionId":{
            "type":"string",
            "description":"Process definition ID of the process to initiate instance"
        },
        "processDefinitionKey":{
            "type":"string",
            "description":"Process definition ID of the process to initiate instance"
        },
        "applicationName":{
            "type":"string",
            "description":"Name of the active application that contains the process to create the instance"
        },
        "applicationVersion":{
            "type":"string",
            "description":"Version of the active application that contains the process to create the instance. If this is empty,\nthe default version is used\n"
        },
        "processName":{
            "type":"string",
            "description":"The name of the process to create the instance"
        }
    }
}

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

型: object

例

Select an example Create a process instance using process definition ID Create a process instance using the process definition key Create a process instance using application name, process name, and default version Create a process instance using application name, process name, and version Create a process instance using form and process definition ID Create a process instance using form and process definition key Create a process instance using form and application name, process name, and default version Create a process instance using form and application name, process name, and version

トップに戻る

レスポンス

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

• application/json

201レスポンス

成功した操作

本文()

ルート・スキーマ : CreateUnifiedInstanceOutput

型: object

すべてに一致

ソースを表示

• object allOf CreateInstanceOutput
• object CreateUnifiedInstanceOutput-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/CreateInstanceOutput"
        },
        {
            "properties":{
                "type":{
                    "type":"string",
                    "enum":[
                        "DYNAMIC",
                        "STRUCTURED"
                    ],
                    "description":"Type of the process instance"
                }
            }
        }
    ]
}

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

型: object

すべてに一致

ソースを表示

• object CommonModel
• object CreateInstanceOutput-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/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":"State of the process instance. This is a union of all possible states of a Dynamic process and a\nStructured process. States specific to a Dynamic process are ACTIVE, CLOSED, COMPLETED and TERMINATED.\nStates specific to a Structured process are ACTIVE, COMPLETED, SUSPENDED, FAULTED, TERMINATED\n",
                    "enum":[
                        "ACTIVE",
                        "COMPLETED",
                        "TERMINATED",
                        "SUSPENDED",
                        "FAULTED",
                        "CLOSED"
                    ]
                },
                "description":{
                    "type":"string",
                    "description":"Description of the process"
                },
                "createdBy":{
                    "$ref":"#/components/schemas/UserOrAppClient"
                },
                "applicationName":{
                    "type":"string",
                    "description":"Application name of the process"
                },
                "applicationVersion":{
                    "type":"string",
                    "description":"Application version of the process"
                },
                "businessKey":{
                    "type":"string",
                    "description":"Business key of the process"
                }
            }
        }
    ]
}

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

型: object

ソースを表示

• links: array links

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

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

型: object

ソースを表示

• applicationName: string
  プロセスのアプリケーション名
• applicationVersion: string
  プロセスのアプリケーション・バージョン
• businessKey: string
  プロセスのビジネス・キー
• createdBy: UserOrAppClient
• description: string
  プロセスの摘要
• id: string
  新しく作成されたインスタンスのインスタンスID
• processDefinitionId: string
  プロセス定義ID
• state: string
  許容値: [ "ACTIVE", "COMPLETED", "TERMINATED", "SUSPENDED", "FAULTED", "CLOSED" ]

  プロセス・インスタンスの状態。 これは、動的プロセスおよび構造化プロセスのすべての可能な状態の結合です。 動的プロセスに固有の状態は、ACTIVE、CLOSED、COMPLETEDおよびTERMINATEDです。 構造化プロセスに固有の状態は、ACTIVE、COMPLETED、SUSPENDED、FAULTED、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":"State of the process instance. This is a union of all possible states of a Dynamic process and a\nStructured process. States specific to a Dynamic process are ACTIVE, CLOSED, COMPLETED and TERMINATED.\nStates specific to a Structured process are ACTIVE, COMPLETED, SUSPENDED, FAULTED, TERMINATED\n",
            "enum":[
                "ACTIVE",
                "COMPLETED",
                "TERMINATED",
                "SUSPENDED",
                "FAULTED",
                "CLOSED"
            ]
        },
        "description":{
            "type":"string",
            "description":"Description of the process"
        },
        "createdBy":{
            "$ref":"#/components/schemas/UserOrAppClient"
        },
        "applicationName":{
            "type":"string",
            "description":"Application name of the process"
        },
        "applicationVersion":{
            "type":"string",
            "description":"Application version of the process"
        },
        "businessKey":{
            "type":"string",
            "description":"Business key of the process"
        }
    }
}

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

型: object

ソースを表示

• type: string
  許容値: [ "DYNAMIC", "STRUCTURED" ]

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

{
    "properties":{
        "type":{
            "type":"string",
            "enum":[
                "DYNAMIC",
                "STRUCTURED"
            ],
            "description":"Type of the process instance"
        }
    }
}

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

型: array

ソースを表示

• Array of: object Link
  リンクの定義

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

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

型: object

リンクの定義

ソースを表示

• code: integer
  最小値: 100

  最大値: 600
• href(required): string
• hreflang: string
• length: integer (int32)
• mediaType: string
• message: string
• rel(required): string
• title: string
• type: string

{
    "type":"object",
    "description":"Defines Link",
    "additionalProperties":false,
    "required":[
        "href",
        "rel"
    ],
    "properties":{
        "href":{
            "type":"string"
        },
        "hreflang":{
            "type":"string"
        },
        "length":{
            "type":"integer",
            "format":"int32"
        },
        "rel":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "code":{
            "type":"integer",
            "minimum":"100",
            "maximum":"600"
        }
    }
}

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

すべてに一致

ソースを表示

• object IdentityCommon
• object Discriminator: type
  Discriminator: { "propertyName":"type" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdentityCommon"
        },
        {
            "type":"object",
            "discriminator":{
                "propertyName":"type"
            },
            "properties":{
                "type":{
                    "type":"string",
                    "enum":[
                        "USER",
                        "APPCLIENT"
                    ]
                }
            }
        }
    ]
}

ネストされたスキーマ : Discriminator: type

型: object

{
    "type":"object",
    "discriminator":{
        "propertyName":"type"
    },
    "properties":{
        "type":{
            "type":"string",
            "enum":[
                "USER",
                "APPCLIENT"
            ]
        }
    }
}

ソースを表示

• type: string
  許容値: [ "USER", "APPCLIENT" ]

{
    "type":"object",
    "discriminator":{
        "propertyName":"type"
    },
    "properties":{
        "type":{
            "type":"string",
            "enum":[
                "USER",
                "APPCLIENT"
            ]
        }
    }
}

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

型: object

ソースを表示

• displayName: string
• id: string
• name: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        }
    }
}

400レスポンス

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

本文()

ルート・スキーマ : ErrorMessage

型: object

タイトル: ErrorMessage

ErrorMessageを定義

ソースを表示

• cause: string
• details: string
• errorCode(required): string
• message(必須): string
• opcRequestId(required): string
• status(required): integer

{
    "title":"ErrorMessage",
    "description":"Defines ErrorMessage",
    "additionalProperties":false,
    "type":"object",
    "required":[
        "errorCode",
        "status",
        "message",
        "opcRequestId"
    ],
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "status":{
            "type":"integer"
        },
        "message":{
            "type":"string"
        },
        "details":{
            "type":"string"
        },
        "cause":{
            "type":"string"
        },
        "opcRequestId":{
            "type":"string"
        }
    }
}

例

Select an example Bad request error

401レスポンス

未認可

本文()

ルート・スキーマ : ErrorMessage

型: object

タイトル: ErrorMessage

ErrorMessageを定義

ソースを表示

• cause: string
• details: string
• errorCode(required): string
• message(必須): string
• opcRequestId(required): string
• status(required): integer

{
    "title":"ErrorMessage",
    "description":"Defines ErrorMessage",
    "additionalProperties":false,
    "type":"object",
    "required":[
        "errorCode",
        "status",
        "message",
        "opcRequestId"
    ],
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "status":{
            "type":"integer"
        },
        "message":{
            "type":"string"
        },
        "details":{
            "type":"string"
        },
        "cause":{
            "type":"string"
        },
        "opcRequestId":{
            "type":"string"
        }
    }
}

例

Select an example Unauthorized error

403レスポンス

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

本文()

ルート・スキーマ : ErrorMessage

型: object

タイトル: ErrorMessage

ErrorMessageを定義

ソースを表示

• cause: string
• details: string
• errorCode(required): string
• message(必須): string
• opcRequestId(required): string
• status(required): integer

{
    "title":"ErrorMessage",
    "description":"Defines ErrorMessage",
    "additionalProperties":false,
    "type":"object",
    "required":[
        "errorCode",
        "status",
        "message",
        "opcRequestId"
    ],
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "status":{
            "type":"integer"
        },
        "message":{
            "type":"string"
        },
        "details":{
            "type":"string"
        },
        "cause":{
            "type":"string"
        },
        "opcRequestId":{
            "type":"string"
        }
    }
}

例

Select an example forbiddenError

404レスポンス

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

本文()

ルート・スキーマ : ErrorMessage

型: object

タイトル: ErrorMessage

ErrorMessageを定義

ソースを表示

• cause: string
• details: string
• errorCode(required): string
• message(必須): string
• opcRequestId(required): string
• status(required): integer

{
    "title":"ErrorMessage",
    "description":"Defines ErrorMessage",
    "additionalProperties":false,
    "type":"object",
    "required":[
        "errorCode",
        "status",
        "message",
        "opcRequestId"
    ],
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "status":{
            "type":"integer"
        },
        "message":{
            "type":"string"
        },
        "details":{
            "type":"string"
        },
        "cause":{
            "type":"string"
        },
        "opcRequestId":{
            "type":"string"
        }
    }
}

例

Select an example Not found error

500レスポンス

内部サーバー・エラー

本文()

ルート・スキーマ : ErrorMessage

型: object

タイトル: ErrorMessage

ErrorMessageを定義

ソースを表示

• cause: string
• details: string
• errorCode(required): string
• message(必須): string
• opcRequestId(required): string
• status(required): integer

{
    "title":"ErrorMessage",
    "description":"Defines ErrorMessage",
    "additionalProperties":false,
    "type":"object",
    "required":[
        "errorCode",
        "status",
        "message",
        "opcRequestId"
    ],
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "status":{
            "type":"integer"
        },
        "message":{
            "type":"string"
        },
        "details":{
            "type":"string"
        },
        "cause":{
            "type":"string"
        },
        "opcRequestId":{
            "type":"string"
        }
    }
}

例

Select an example Internal error

先頭に戻る