Jump to

• Request
• Response

Control a Dynamic Process Execution

put

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

Perform the specified action on the process execution.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  Process execution ID.

Body ()

Action to be performed and variables to update

Root Schema : ExecutionActionInput

Type: object

Show Source

• action(optional): string
  Allowed Values: [ "manual-start", "complete", "disable", "reenable", "reactivate" ]

  manual-start, complete ,disable , reenable, or reactivate
• deletions(optional): array deletions
• variables(optional): object VariablesMap
  Additional Properties Allowed: additionalProperties

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

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

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(optional): 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

Supported Media Types

• application/json

200 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 upon because of CMMN restrictions.

404 Response

A process execution with the specified ID was not found.

500 Response

Internal Server Error.

Back to Top