Manage Process Instances

Get and delete process instances.

This API retrieves the given process instance.

Path Parameters

  • tenantIdstringrequired

    clientId of the tenant

  • processInstanceIdstringrequired

    UUID of the process instance

Responses

  • idstringrequired

    Unique process instance id

  • processDefinitionIdstringrequired

    Process definition uniqueId

  • processDefinitionNamestringrequired

    Process definition name

  • processDefinitionVersionnumberrequired

    Process definition version

  • startTimenumberrequired

    Start time in long number

  • deploymentIdstringrequired

    Process definition delployment Id

  • startEventIdstringrequired

    unique start event idenfier

  • tenantIdstringrequired

    Client uuid

  • statestringrequired

    Current state

    Enum:
    ACTIVEINACTIVE
  • diagramstring

    Process definition workflow

  • activityInstancesarray

    Activity instances collections

  • userTasksarray

    Uer

  • statisticsarray

    Process statistics collection

  • errorsarray of strings

    Error collections.

  • variablesarray

    REST output object collection.

Loading Examples...

This API cancels the given running process instance.

Path Parameters

  • tenantIdstringrequired

    clientId of the tenant

  • processInstanceIdstringrequired

    UUID of the process instance

Responses

200OK