Jump to

• Request
• Response

Perform an Action on Process Instance

put

/process/api/v1/instances/{id}

Perform the specified action on the process instance. Supported actions are TERMINATE, SUSPEND, RESUME, ALTER_FLOW for a Structured Process and CLOSE, COMPLETE, SUSPEND, RESUME, TERMINATE for a Dynamic Process. The TERMINATE action of a dynamic process is controlled by the terminateChildInstances property flag (boolean value). If set to true, it terminates all the linked structured processes. When set to false, the linked structured processes are active. By default, this property is set to false. You can also specify the reason when using this flag.

Request

Path Parameters

• id(required): string
  Process Instance Id

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Match All

Show Source

• object BaseInstanceActionInput
• object properties

{
    "type":"object",
    "required":[
        "action"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/BaseInstanceActionInput"
        },
        {
            "properties":{
                "action":{
                    "type":"string",
                    "description":"The action to perform on the instance. CLOSE, COMPLETE, SUSPEND, RESUME and TERMINATE are valid actions for a Dynamic Process.\nSUSPEND, RESUME and TERMINATE, ALTER_FLOW are valid actions for a Structured Process\n",
                    "enum":[
                        "CLOSE",
                        "COMPLETE",
                        "SUSPEND",
                        "TERMINATE",
                        "RESUME",
                        "UPDATE",
                        "ALTER_FLOW"
                    ]
                },
                "dataObjects":{
                    "$ref":"#/components/schemas/VariablesMap"
                },
                "deletions":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        }
    ]
}

Nested Schema : BaseInstanceActionInput

Type: object

Show Source

• instanceActionProps: object InstanceActionProps
  Additional Properties Allowed: additionalProperties

  a (key, MapItem) map. `default`is an example key.

{
    "type":"object",
    "properties":{
        "instanceActionProps":{
            "$ref":"#/components/schemas/InstanceActionProps"
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• action: string
  Allowed Values: [ "CLOSE", "COMPLETE", "SUSPEND", "TERMINATE", "RESUME", "UPDATE", "ALTER_FLOW" ]

  The action to perform on the instance. CLOSE, COMPLETE, SUSPEND, RESUME and TERMINATE are valid actions for a Dynamic Process. SUSPEND, RESUME and TERMINATE, ALTER_FLOW are valid actions for a Structured Process
• dataObjects: VariablesMap
  Additional Properties Allowed: additionalProperties

  A (key, MapItem) map. `default`is an example key.
• deletions: array deletions

{
    "properties":{
        "action":{
            "type":"string",
            "description":"The action to perform on the instance. CLOSE, COMPLETE, SUSPEND, RESUME and TERMINATE are valid actions for a Dynamic Process.\nSUSPEND, RESUME and TERMINATE, ALTER_FLOW are valid actions for a Structured Process\n",
            "enum":[
                "CLOSE",
                "COMPLETE",
                "SUSPEND",
                "TERMINATE",
                "RESUME",
                "UPDATE",
                "ALTER_FLOW"
            ]
        },
        "dataObjects":{
            "$ref":"#/components/schemas/VariablesMap"
        },
        "deletions":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : InstanceActionProps

Type: object

Additional Properties Allowed

Show Source

• string

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

a (key, MapItem) map. `default`is an example key.

Nested Schema : VariablesMap

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

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

A (key, MapItem) map. `default`is an example key.

Show Source

• default: object default

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

Nested Schema : deletions

Type: array

Show Source

• Array of: string

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

Nested Schema : default

Type: object

Nested Schema : additionalProperties

Type: object

Examples

Select an example Terminate an instance Suspend structured process Perform Alterflow

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful operation

Body ()

Root Schema : ModelApiResponse

Type: object

Show Source

• message: string
  Response message
• type: string
  Allowed Values: [ "ok" ]

  API response type

{
    "type":"object",
    "properties":{
        "message":{
            "type":"string",
            "description":"Response message"
        },
        "type":{
            "type":"string",
            "description":"API response type",
            "enum":[
                "ok"
            ]
        }
    }
}

Examples

Select an example Alterflow response

204 Response

successful operation

400 Response

The process instance action request is invalid, that is if InstanceAction input is null or contains invalid action.

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

The process instance with given ID is not found

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

409 Response

The state transition is not allowed to be performed. For example, when the process instance is already in terminal state completed or terminated.

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

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