Create a Process Instance
post
/process/api/v1/instances
Create a new instance of the process. You can use any of the following to create an instance: processDefinitionId, processDefinitionKey, and applicationName with applicationVersion and processName. When creating by applicationName, applicationVersion and processName, the applicationVersion is optional. If the applicationVersion is not provided, then the default version is selected to create the instance.
Request
Header Parameters
-
oci-original-url:
Actual endpoint which customer requested
Supported Media Types
- application/json
Root Schema : schema
Type:
object
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.
Show Source
-
dataObject: object
dataObject
Additional Properties Allowed: additionalProperties
-
default: object
default
-
params: object
params
Nested Schema : default
Type:
object
Nested Schema : params
Type:
Show Source
object
-
applicationName: string
Name of the active application that contains the process to create the instance
-
applicationVersion: string
Version of the active application that contains the process to create the instance. If this is empty, the default version is used
-
processDefinitionId: string
Process definition ID of the process to initiate instance
-
processDefinitionKey: string
Process definition ID of the process to initiate instance
-
processName: string
The name of the process to create the instance
Nested Schema : additionalProperties
Type:
object
Examples
Back to Top
Response
Supported Media Types
- application/json
201 Response
successful operation
Nested Schema : CreateInstanceOutput-allOf[1]
Type:
Show Source
object
-
applicationName: string
Application name of the process
-
applicationVersion: string
Application version of the process
-
businessKey: string
Business key of the process
-
createdBy:
UserOrAppClient
-
description: string
Description of the process
-
id: string
Instance Id of newly created instance
-
processDefinitionId: string
Process definition Id
-
state: string
Allowed Values:
[ "ACTIVE", "COMPLETED", "TERMINATED", "SUSPENDED", "FAULTED", "CLOSED" ]
State of the process instance. This is a union of all possible states of a Dynamic process and a Structured process. States specific to a Dynamic process are ACTIVE, CLOSED, COMPLETED and TERMINATED. States specific to a Structured process are ACTIVE, COMPLETED, SUSPENDED, FAULTED, TERMINATED -
title: string
Title of the instance
Nested Schema : CreateUnifiedInstanceOutput-allOf[1]
Type:
Show Source
object
-
type: string
Allowed Values:
[ "DYNAMIC", "STRUCTURED" ]
Type of the process instance
Nested Schema : Link
Type:
object
Defines Link
Show Source
-
code: integer
Minimum Value:
100
Maximum Value:600
-
href(required): string
-
hreflang: string
-
length: integer
(int32)
-
mediaType: string
-
message: string
-
rel(required): string
-
title: string
-
type: string
Nested Schema : UserOrAppClient
Match All
Show Source
-
object
IdentityCommon
-
object
Discriminator: type
Discriminator:
{ "propertyName":"type" }
Nested Schema : Discriminator: type
Type:
Show Source
object
-
type: string
Allowed Values:
[ "USER", "APPCLIENT" ]
400 Response
Returned if the body parameter is invalid
Examples
401 Response
Unauthorized
Examples
403 Response
The process execution cannot be instantiated because of Process restrictions
Examples
404 Response
Process definition does not exist.
Examples
500 Response
Internal server error
Examples