Jump to

• Request
• Response

Perform an Action on a Process Execution

put

/process/api/v1/process-executions/{id}

Performs an action on a process execution. You can use this API function only on structured processes.

Request

Path Parameters

• id(required): string
  Process Execution ID

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• action: string
  Allowed Values: [ "signal", "manual-start", "complete", "disable", "reenable", "reactivate", "terminate" ]

  signal
• deletions: array deletions
• variables: VariablesMap
  Additional Properties Allowed: additionalProperties

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

{
    "type":"object",
    "properties":{
        "variables":{
            "$ref":"#/components/schemas/VariablesMap"
        },
        "deletions":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "action":{
            "type":"string",
            "description":"signal",
            "enum":[
                "signal",
                "manual-start",
                "complete",
                "disable",
                "reenable",
                "reactivate",
                "terminate"
            ]
        }
    }
}

Nested Schema : deletions

Type: array

Show Source

• Array of: string

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

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

Type: object

Nested Schema : additionalProperties

Type: object

Back to Top

Response

204 Response

Successful operation

400 Response

The state transition is not allowed to be performed, for example when the process execution is enabled or is already completed

401 Response

Unauthorized

403 Response

The process execution cannot be acted on because of Process restrictions

404 Response

The process execution with given id is not found

429 Response

Too many requests

500 Response

Internal server error

503 Response

Too many exceptions or too slow requests

Back to Top