Jump to

• Request
• Response

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: string
  Actual endpoint which customer requested

Supported Media Types

• application/json

Request Body - 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

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

Nested Schema : dataObject

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

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

Nested Schema : default

Type: object

Nested Schema : params

Type: object

Show Source

• 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

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

Nested Schema : additionalProperties

Type: object

Examples

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

Back to Top

Response

Supported Media Types

• application/json

201 Response

successful operation

Body ()

Root Schema : CreateUnifiedInstanceOutput

Type: object

Match All

Show Source

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

Nested Schema : CreateInstanceOutput

Type: object

Match All

Show Source

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

Nested Schema : CommonModel

Type: object

Show Source

• links: array links

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

Nested Schema : CreateInstanceOutput-allOf[1]

Type: object

Show Source

• 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

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

Nested Schema : CreateUnifiedInstanceOutput-allOf[1]

Type: object

Show Source

• type: string
  Allowed Values: [ "DYNAMIC", "STRUCTURED" ]

  Type of the process instance

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

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Defines Link

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

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

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

Nested Schema : UserOrAppClient

Match All

Show Source

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

Nested Schema : Discriminator: type

Type: object

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

Show Source

• type: string
  Allowed Values: [ "USER", "APPCLIENT" ]

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

Nested Schema : IdentityCommon

Type: object

Show Source

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

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

400 Response

Returned if the body parameter is invalid

Body ()

Root Schema : ErrorMessage

Type: object

Title: ErrorMessage

Defines ErrorMessage

Show Source

• cause: string
• details: string
• errorCode(required): string
• message(required): 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"
        }
    }
}

Examples

Select an example Bad request error

401 Response

Unauthorized

Body ()

Root Schema : ErrorMessage

Type: object

Title: ErrorMessage

Defines ErrorMessage

Show Source

• cause: string
• details: string
• errorCode(required): string
• message(required): 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"
        }
    }
}

Examples

Select an example Unauthorized error

403 Response

The process execution cannot be instantiated because of Process restrictions

Body ()

Root Schema : ErrorMessage

Type: object

Title: ErrorMessage

Defines ErrorMessage

Show Source

• cause: string
• details: string
• errorCode(required): string
• message(required): 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"
        }
    }
}

Examples

Select an example forbiddenError

404 Response

Process definition does not exist.

Body ()

Root Schema : ErrorMessage

Type: object

Title: ErrorMessage

Defines ErrorMessage

Show Source

• cause: string
• details: string
• errorCode(required): string
• message(required): 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"
        }
    }
}

Examples

Select an example Not found error

500 Response

Internal server error

Body ()

Root Schema : ErrorMessage

Type: object

Title: ErrorMessage

Defines ErrorMessage

Show Source

• cause: string
• details: string
• errorCode(required): string
• message(required): 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"
        }
    }
}

Examples

Select an example Internal error

Back to Top