Resources

Administration Of Cases :: Case Management

Retrieves case instances without authentication checks and applies pagination

GET /server/admin/cases/instances
Parameters
Type Name Description Schema Default

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Query

sort
optional

optional sort column, no default

string

Query

sortOrder
optional

optional sort direction (asc, desc) - defaults to asc

boolean

"true"

Query

status
optional

optional case instance status (open, closed, canceled) - defaults ot open (1) only

< enum (open, closed, cancelled) > array(multi)

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/admin/cases/instances
Example HTTP response
Response 200
{
  "instances" : [ {
    "case-id" : "string",
    "case-description" : "string",
    "case-owner" : "string",
    "case-status" : 0,
    "case-definition-id" : "string",
    "container-id" : "string",
    "case-started-at" : "1970-01-01T00:00:00Z",
    "case-completed-at" : "1970-01-01T00:00:00Z",
    "case-completion-msg" : "string",
    "case-sla-compliance" : 0,
    "case-sla-due-date" : "1970-01-01T00:00:00Z",
    "case-file" : {
      "case-data" : {
        "string" : "object"
      },
      "case-user-assignments" : {
        "string" : "string"
      },
      "case-group-assignments" : {
        "string" : "string"
      },
      "case-data-restrictions" : {
        "string" : [ "string" ]
      }
    },
    "case-milestones" : [ {
      "milestone-name" : "string",
      "milestone-id" : "string",
      "milestone-achieved" : true,
      "milestone-achieved-at" : "1970-01-01T00:00:00Z",
      "milestone-status" : "string"
    } ],
    "case-stages" : [ {
      "stage-name" : "string",
      "stage-id" : "string",
      "stage-status" : "string",
      "adhoc-fragments" : [ {
        "name" : "string",
        "type" : "string"
      } ],
      "active-nodes" : [ {
        "node-instance-id" : 0,
        "node-name" : "string",
        "process-instance-id" : 0,
        "work-item-id" : 0,
        "container-id" : "string",
        "start-date" : "1970-01-01T00:00:00Z",
        "node-id" : "string",
        "node-type" : "string",
        "node-connection" : "string",
        "node-completed" : true,
        "reference-id" : 0,
        "sla-compliance" : 0,
        "sla-due-date" : "1970-01-01T00:00:00Z"
      } ]
    } ],
    "case-roles" : [ {
      "name" : "string",
      "users" : [ "string" ],
      "groups" : [ "string" ]
    } ]
  } ]
}

Migrates case instance to new container and case definition with required process mapping to migrate all process instances belonging to a case instance with optional node mapping

PUT /server/admin/containers/{id}/cases/instances/{caseId}
Parameters
Type Name Description Schema

Path

caseId
required

identifier of case instance to be migrated

string

Path

id
required

container id that case instance belongs to

string

Query

targetContainerId
required

container id that new case definition should be migrated to to

string

Body

body
optional

process and node mapping - unique ids of old definition to new definition given as Map of Maps - ProcessMapping should provide map of process definitions (mandatory), NodeMapping should provide map of node mappings (optional)

string

Responses
HTTP Code Description Schema

201

successful operation

404

Case instance or Container Id not found

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/admin/containers/string/cases/instances/string?targetContainerId=string
Request body
{
  "NodeMapping" : { },
  "ProcessMapping" : {
    "insurance-claims.CarInsuranceClaimCase" : "insurance-claims.CarInsuranceClaimCase2"
  }
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<map-type>
    <entries>
        <entry>
            <key>ProcessMapping</key>
            <value xsi:type="jaxbMap" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <entries>
                    <entry>
                        <key>insurance-claims.CarInsuranceClaimCase</key>
                        <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">insurance-claims.CarInsuranceClaimCase2</value>
                    </entry>
                </entries>
            </value>
        </entry>
        <entry>
            <key>NodeMapping</key>
            <value xsi:type="jaxbMap" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <entries/>
            </value>
        </entry>
    </entries>
</map-type>
Example HTTP response
Response 201
{
  "case-id" : "string",
  "case-migration-successful" : true,
  "case-migration-start" : "1970-01-01T00:00:00Z",
  "case-migration-end" : "1970-01-01T00:00:00Z",
  "case-migration-reports" : [ {
    "migration-successful" : true,
    "migration-start" : "1970-01-01T00:00:00Z",
    "migration-end" : "1970-01-01T00:00:00Z",
    "migration-logs" : [ "string" ],
    "migration-process-instance" : 0
  } ]
}

Asynchronous Jobs :: BPM

Schedules new asynchronous job based on given body

POST /server/jobs
Parameters
Type Name Description Schema

Query

containerId
optional

optional container id that the job should be associated with

string

Body

body
required

asynchronous job definition represented as JobRequestInstance

string

Responses
HTTP Code Description Schema

201

successful operation

integer (int64)

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/jobs
Request body
{
  "job-command" : "org.jbpm.executor.commands.PrintOutCommand",
  "scheduled-date" : {
    "java.util.Date" : 1540023411655
  },
  "request-data" : {
    "businessKey" : "test key"
  }
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<job-request-instance>
    <job-command>org.jbpm.executor.commands.PrintOutCommand</job-command>
    <scheduled-date>2018-10-20T10:16:51.326+02:00</scheduled-date>
    <data>
        <entry>
            <key>businessKey</key>
            <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">test key</value>
        </entry>
    </data>
</job-request-instance>
Example HTTP response
Response 201
0

Retrieves asynchronous jobs filtered by status

GET /server/jobs
Parameters
Type Name Description Schema Default

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Query

status
required

optional job status (QUEUED, DONE, CANCELLED, ERROR, RETRYING, RUNNING)

< enum (QUEUED, DONE, CANCELLED, ERROR, RETRYING, RUNNING) > array(multi)

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/jobs?status=QUEUED
Example HTTP response
Response 200
{
  "request-info-instance" : [ {
    "request-instance-id" : 0,
    "request-status" : "string",
    "request-business-key" : "string",
    "request-message" : "string",
    "request-retries" : 0,
    "request-executions" : 0,
    "request-command" : "string",
    "request-scheduled-date" : "1970-01-01T00:00:00Z",
    "request-data" : {
      "string" : "object"
    },
    "response-data" : {
      "string" : "object"
    },
    "request-errors" : {
      "error-info-instance" : [ {
        "error-instance-id" : 0,
        "request-instance-id" : 0,
        "error-message" : "string",
        "error-stacktrace" : "string",
        "error-date" : "1970-01-01T00:00:00Z"
      } ]
    },
    "request-container-id" : "string"
  } ]
}

Retrieves asynchronous jobs by command

GET /server/jobs/commands/{cmd}
Parameters
Type Name Description Schema Default

Path

cmd
required

name of the command that asynchornous jobs should be found for

string

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Query

status
optional

optional job status (QUEUED, DONE, CANCELLED, ERROR, RETRYING, RUNNING)

< enum (QUEUED, DONE, CANCELLED, ERROR, RETRYING, RUNNING) > array(multi)

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/jobs/commands/string
Example HTTP response
Response 200
{
  "request-info-instance" : [ {
    "request-instance-id" : 0,
    "request-status" : "string",
    "request-business-key" : "string",
    "request-message" : "string",
    "request-retries" : 0,
    "request-executions" : 0,
    "request-command" : "string",
    "request-scheduled-date" : "1970-01-01T00:00:00Z",
    "request-data" : {
      "string" : "object"
    },
    "response-data" : {
      "string" : "object"
    },
    "request-errors" : {
      "error-info-instance" : [ {
        "error-instance-id" : 0,
        "request-instance-id" : 0,
        "error-message" : "string",
        "error-stacktrace" : "string",
        "error-date" : "1970-01-01T00:00:00Z"
      } ]
    },
    "request-container-id" : "string"
  } ]
}

Retrieves asynchronous jobs by container

GET /server/jobs/containers/{id}
Parameters
Type Name Description Schema Default

Path

id
required

identifier of the container that asynchornous jobs should be found for

string

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Query

status
optional

optional job status (QUEUED, DONE, CANCELLED, ERROR, RETRYING, RUNNING)

< enum (QUEUED, DONE, CANCELLED, ERROR, RETRYING, RUNNING) > array(multi)

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/jobs/containers/string
Example HTTP response
Response 200
{
  "request-info-instance" : [ {
    "request-instance-id" : 0,
    "request-status" : "string",
    "request-business-key" : "string",
    "request-message" : "string",
    "request-retries" : 0,
    "request-executions" : 0,
    "request-command" : "string",
    "request-scheduled-date" : "1970-01-01T00:00:00Z",
    "request-data" : {
      "string" : "object"
    },
    "response-data" : {
      "string" : "object"
    },
    "request-errors" : {
      "error-info-instance" : [ {
        "error-instance-id" : 0,
        "request-instance-id" : 0,
        "error-message" : "string",
        "error-stacktrace" : "string",
        "error-date" : "1970-01-01T00:00:00Z"
      } ]
    },
    "request-container-id" : "string"
  } ]
}

Retrieves asynchronous jobs by business key

GET /server/jobs/keys/{key}
Parameters
Type Name Description Schema Default

Path

key
required

identifier of the business key that asynchornous jobs should be found for

string

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Query

status
optional

optional job status (QUEUED, DONE, CANCELLED, ERROR, RETRYING, RUNNING)

< enum (QUEUED, DONE, CANCELLED, ERROR, RETRYING, RUNNING) > array(multi)

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/jobs/keys/string
Example HTTP response
Response 200
{
  "request-info-instance" : [ {
    "request-instance-id" : 0,
    "request-status" : "string",
    "request-business-key" : "string",
    "request-message" : "string",
    "request-retries" : 0,
    "request-executions" : 0,
    "request-command" : "string",
    "request-scheduled-date" : "1970-01-01T00:00:00Z",
    "request-data" : {
      "string" : "object"
    },
    "response-data" : {
      "string" : "object"
    },
    "request-errors" : {
      "error-info-instance" : [ {
        "error-instance-id" : 0,
        "request-instance-id" : 0,
        "error-message" : "string",
        "error-stacktrace" : "string",
        "error-date" : "1970-01-01T00:00:00Z"
      } ]
    },
    "request-container-id" : "string"
  } ]
}

Retrieves asynchronous jobs by process instance id

GET /server/jobs/processes/instances/{pInstanceId}
Parameters
Type Name Description Schema Default

Path

pInstanceId
required

identifier of the process instance that asynchornous jobs should be found for

integer (int64)

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Query

status
optional

optional job status (QUEUED, DONE, CANCELLED, ERROR, RETRYING, RUNNING)

< enum (QUEUED, DONE, CANCELLED, ERROR, RETRYING, RUNNING) > array(multi)

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/jobs/processes/instances/0
Example HTTP response
Response 200
{
  "request-info-instance" : [ {
    "request-instance-id" : 0,
    "request-status" : "string",
    "request-business-key" : "string",
    "request-message" : "string",
    "request-retries" : 0,
    "request-executions" : 0,
    "request-command" : "string",
    "request-scheduled-date" : "1970-01-01T00:00:00Z",
    "request-data" : {
      "string" : "object"
    },
    "response-data" : {
      "string" : "object"
    },
    "request-errors" : {
      "error-info-instance" : [ {
        "error-instance-id" : 0,
        "request-instance-id" : 0,
        "error-message" : "string",
        "error-stacktrace" : "string",
        "error-date" : "1970-01-01T00:00:00Z"
      } ]
    },
    "request-container-id" : "string"
  } ]
}

Retrieves asynchronous job by given jobId

GET /server/jobs/{jobId}
Parameters
Type Name Description Schema

Path

jobId
required

identifier of the asynchronous job to be retrieved

integer (int64)

Query

withData
optional

optional flag that indicats if input/output data should be loaded as well

boolean

Query

withErrors
optional

optional flag that indicats if errors should be loaded as well

boolean

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/jobs/0
Example HTTP response
Response 200
{
  "request-instance-id" : 0,
  "request-status" : "string",
  "request-business-key" : "string",
  "request-message" : "string",
  "request-retries" : 0,
  "request-executions" : 0,
  "request-command" : "string",
  "request-scheduled-date" : "1970-01-01T00:00:00Z",
  "request-data" : {
    "string" : "object"
  },
  "response-data" : {
    "string" : "object"
  },
  "request-errors" : {
    "error-info-instance" : [ {
      "error-instance-id" : 0,
      "request-instance-id" : 0,
      "error-message" : "string",
      "error-stacktrace" : "string",
      "error-date" : "1970-01-01T00:00:00Z"
    } ]
  },
  "request-container-id" : "string"
}

Requeues failed asynchronous job identified by given jobId

PUT /server/jobs/{jobId}
Parameters
Type Name Description Schema

Path

jobId
required

identifier of the asynchronous job to be requeued

integer (int64)

Responses
HTTP Code Description Schema

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/jobs/0

Cancels active asynchronous job identified by given jobId

DELETE /server/jobs/{jobId}
Parameters
Type Name Description Schema

Path

jobId
required

identifier of the asynchronous job to be canceled

integer (int64)

Responses
HTTP Code Description Schema

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/jobs/0

Updates active asynchronous job’s data (identified by given jobId)

POST /server/jobs/{jobId}/data
Parameters
Type Name Description Schema

Path

jobId
required

identifier of the asynchronous job to be updated

integer (int64)

Query

containerId
optional

optional container id that the job should be associated with

string

Body

body
required

data to be updated on the asynchronous job represented as Map

string

Responses
HTTP Code Description Schema

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/jobs/0/data
Request body
{
    "age": 25,
    "person": {
        "Person": {
            "name": "john"
        }
    }
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<map-type>
    <entries>
        <entry>
            <key>age</key>
            <value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema"
                    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">25</value>
        </entry>
        <entry>
            <key>person</key>
            <value xsi:type="person" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <name>john</name>
            </value>
        </entry>
    </entries>
</map-type>

Case Instances :: Case Management

Retrieves case definition for given container only, applies pagination

GET /server/containers/{id}/cases/definitions
Parameters
Type Name Description Schema Default

Path

id
required

container id that should be used to filter case definitions

string

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Query

sort
optional

optional sort column, no default

string

Query

sortOrder
optional

optional sort direction (asc, desc) - defaults to asc

boolean

"true"

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/cases/definitions
Example HTTP response
Response 200
{
  "definitions" : [ {
    "name" : "string",
    "id" : "string",
    "version" : "string",
    "case-id-prefix" : "string",
    "container-id" : "string",
    "adhoc-fragments" : [ {
      "name" : "string",
      "type" : "string"
    } ],
    "roles" : {
      "string" : 0
    },
    "milestones" : [ {
      "milestone-name" : "string",
      "milestone-id" : "string",
      "milestone-mandatory" : true
    } ],
    "stages" : [ {
      "stage-name" : "string",
      "stage-id" : "string",
      "adhoc-fragments" : [ {
        "name" : "string",
        "type" : "string"
      } ]
    } ]
  } ]
}

Retrieves case definition for given container and case definition id

GET /server/containers/{id}/cases/definitions/{caseDefId}
Parameters
Type Name Description Schema

Path

caseDefId
required

case definition id that should be loaded

string

Path

id
required

container id that should be used to filter case definitions

string

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/cases/definitions/string
Example HTTP response
Response 200
{
  "name" : "string",
  "id" : "string",
  "version" : "string",
  "case-id-prefix" : "string",
  "container-id" : "string",
  "adhoc-fragments" : [ {
    "name" : "string",
    "type" : "string"
  } ],
  "roles" : {
    "string" : 0
  },
  "milestones" : [ {
    "milestone-name" : "string",
    "milestone-id" : "string",
    "milestone-mandatory" : true
  } ],
  "stages" : [ {
    "stage-name" : "string",
    "stage-id" : "string",
    "adhoc-fragments" : [ {
      "name" : "string",
      "type" : "string"
    } ]
  } ]
}

Retrieves case instances for given container only, allows to filter by case instance status and applies pagination

GET /server/containers/{id}/cases/instances
Parameters
Type Name Description Schema Default

Path

id
required

container id that should be used to filter case instances

string

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Query

sort
optional

optional sort column, no default

string

Query

sortOrder
optional

optional sort direction (asc, desc) - defaults to asc

boolean

"true"

Query

status
optional

optional case instance status (open, closed, canceled) - defaults ot open (1) only

< enum (open, closed, cancelled) > array(multi)

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/cases/instances
Example HTTP response
Response 200
{
  "instances" : [ {
    "case-id" : "string",
    "case-description" : "string",
    "case-owner" : "string",
    "case-status" : 0,
    "case-definition-id" : "string",
    "container-id" : "string",
    "case-started-at" : "1970-01-01T00:00:00Z",
    "case-completed-at" : "1970-01-01T00:00:00Z",
    "case-completion-msg" : "string",
    "case-sla-compliance" : 0,
    "case-sla-due-date" : "1970-01-01T00:00:00Z",
    "case-file" : {
      "case-data" : {
        "string" : "object"
      },
      "case-user-assignments" : {
        "string" : "string"
      },
      "case-group-assignments" : {
        "string" : "string"
      },
      "case-data-restrictions" : {
        "string" : [ "string" ]
      }
    },
    "case-milestones" : [ {
      "milestone-name" : "string",
      "milestone-id" : "string",
      "milestone-achieved" : true,
      "milestone-achieved-at" : "1970-01-01T00:00:00Z",
      "milestone-status" : "string"
    } ],
    "case-stages" : [ {
      "stage-name" : "string",
      "stage-id" : "string",
      "stage-status" : "string",
      "adhoc-fragments" : [ {
        "name" : "string",
        "type" : "string"
      } ],
      "active-nodes" : [ {
        "node-instance-id" : 0,
        "node-name" : "string",
        "process-instance-id" : 0,
        "work-item-id" : 0,
        "container-id" : "string",
        "start-date" : "1970-01-01T00:00:00Z",
        "node-id" : "string",
        "node-type" : "string",
        "node-connection" : "string",
        "node-completed" : true,
        "reference-id" : 0,
        "sla-compliance" : 0,
        "sla-due-date" : "1970-01-01T00:00:00Z"
      } ]
    } ],
    "case-roles" : [ {
      "name" : "string",
      "users" : [ "string" ],
      "groups" : [ "string" ]
    } ]
  } ]
}

Closes case instance with given identifier (case id) optionally with comment

POST /server/containers/{id}/cases/instances/{caseId}
Parameters
Type Name Description Schema

Path

caseId
required

identifier of the case instance

string

Path

id
required

container id that case instance belongs to

string

Body

body
optional

optional comment when closing a case instance as String

string

Responses
HTTP Code Description Schema

404

Case instance not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/cases/instances/string
Request body

Retrieves active case instance by given identifier (case id) with optionally loading data, roles, milestones and stages

GET /server/containers/{id}/cases/instances/{caseId}
Parameters
Type Name Description Schema Default

Path

caseId
required

identifier of the case instance

string

Path

id
required

container id that case instance belongs to

string

Query

withData
optional

optional flag to load data when loading case instance

boolean

"false"

Query

withMilestones
optional

optional flag to load milestones when loading case instance

boolean

"false"

Query

withRoles
optional

optional flag to load roles when loading case instance

boolean

"false"

Query

withStages
optional

optional flag to load stages when loading case instance

boolean

"false"

Responses
HTTP Code Description Schema

200

successful operation

404

Case instance not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/cases/instances/string
Example HTTP response
Response 200
{
  "case-id" : "string",
  "case-description" : "string",
  "case-owner" : "string",
  "case-status" : 0,
  "case-definition-id" : "string",
  "container-id" : "string",
  "case-started-at" : "1970-01-01T00:00:00Z",
  "case-completed-at" : "1970-01-01T00:00:00Z",
  "case-completion-msg" : "string",
  "case-sla-compliance" : 0,
  "case-sla-due-date" : "1970-01-01T00:00:00Z",
  "case-file" : {
    "case-data" : {
      "string" : "object"
    },
    "case-user-assignments" : {
      "string" : "string"
    },
    "case-group-assignments" : {
      "string" : "string"
    },
    "case-data-restrictions" : {
      "string" : [ "string" ]
    }
  },
  "case-milestones" : [ {
    "milestone-name" : "string",
    "milestone-id" : "string",
    "milestone-achieved" : true,
    "milestone-achieved-at" : "1970-01-01T00:00:00Z",
    "milestone-status" : "string"
  } ],
  "case-stages" : [ {
    "stage-name" : "string",
    "stage-id" : "string",
    "stage-status" : "string",
    "adhoc-fragments" : [ {
      "name" : "string",
      "type" : "string"
    } ],
    "active-nodes" : [ {
      "node-instance-id" : 0,
      "node-name" : "string",
      "process-instance-id" : 0,
      "work-item-id" : 0,
      "container-id" : "string",
      "start-date" : "1970-01-01T00:00:00Z",
      "node-id" : "string",
      "node-type" : "string",
      "node-connection" : "string",
      "node-completed" : true,
      "reference-id" : 0,
      "sla-compliance" : 0,
      "sla-due-date" : "1970-01-01T00:00:00Z"
    } ]
  } ],
  "case-roles" : [ {
    "name" : "string",
    "users" : [ "string" ],
    "groups" : [ "string" ]
  } ]
}

Cancels case instance with given identifier (case id) and has optional flag to permanently destroy the case instance

DELETE /server/containers/{id}/cases/instances/{caseId}
Parameters
Type Name Description Schema Default

Path

caseId
required

identifier of the case instance

string

Path

id
required

container id that case instance belongs to

string

Query

destroy
optional

allows to destroy (permanently) case instance as part of the cancel operation, defaults to false

boolean

"false"

Responses
HTTP Code Description Schema

404

Case instance not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/cases/instances/string

Retrieves adhoc fragments from case instance

GET /server/containers/{id}/cases/instances/{caseId}/adhocfragments
Parameters
Type Name Description Schema

Path

caseId
required

identifier of the case instance

string

Path

id
required

container id that case instance belongs to

string

Responses
HTTP Code Description Schema

200

successful operation

404

Case instance not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/cases/instances/string/adhocfragments
Example HTTP response
Response 200
{
  "fragments" : [ {
    "name" : "string",
    "type" : "string"
  } ]
}

Puts new data (map of variables) into case instance’s case file

POST /server/containers/{id}/cases/instances/{caseId}/caseFile
Parameters
Type Name Description Schema

Path

caseId
required

identifier of the case instance

string

Path

id
required

container id that case instance belongs to

string

Query

restrictedTo
optional

optional role name(s) that given data should be restricted to

< string > array(multi)

Body

body
required

map of data to be placed in case file as Map

string

Responses
HTTP Code Description Schema

404

Case instance not found

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/cases/instances/string/caseFile
Request body
{
    "age": 25,
    "person": {
        "Person": {
            "name": "john"
        }
    }
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<map-type>
    <entries>
        <entry>
            <key>age</key>
            <value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema"
                    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">25</value>
        </entry>
        <entry>
            <key>person</key>
            <value xsi:type="person" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <name>john</name>
            </value>
        </entry>
    </entries>
</map-type>

Retrieves case instance data as map where key is the name of data item and value is actual instance of the data item from case file

GET /server/containers/{id}/cases/instances/{caseId}/caseFile
Parameters
Type Name Description Schema

Path

caseId
required

identifier of the case instance

string

Path

id
required

container id that case instance belongs to

string

Query

name
optional

optional name(s) of the data items to retrieve

< string > array(multi)

Responses
HTTP Code Description Schema

200

successful operation

< string, object > map

404

Case instance not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/cases/instances/string/caseFile
Example HTTP response
Response 200
"object"

Removes data items identified by name(s) from case instance’s case file

DELETE /server/containers/{id}/cases/instances/{caseId}/caseFile
Parameters
Type Name Description Schema

Path

caseId
required

identifier of the case instance

string

Path

id
required

container id that case instance belongs to

string

Query

dataId
required

one or more names of the data items to be removed from case file

< string > array(multi)

Responses
HTTP Code Description Schema

404

Case instance not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/cases/instances/string/caseFile?dataId=string

Puts new data (single data identified by name) into case instance’s case file

POST /server/containers/{id}/cases/instances/{caseId}/caseFile/{dataId}
Parameters
Type Name Description Schema

Path

caseId
required

identifier of the case instance

string

Path

dataId
required

name of the data item to be added to case file

string

Path

id
required

container id that case instance belongs to

string

Query

restrictedTo
optional

optional role name(s) that given data should be restricted to

< string > array(multi)

Body

body
required

data to be placed in case file, any type can be provided

string

Responses
HTTP Code Description Schema

404

Case instance not found

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/cases/instances/string/caseFile/string
Request body
{
    "Person": {
        "name": "john"
    }
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<person>
    <name>john</name>
</person>

Retrieves case instance data by data item name

GET /server/containers/{id}/cases/instances/{caseId}/caseFile/{dataId}
Parameters
Type Name Description Schema

Path

caseId
required

identifier of the case instance

string

Path

dataId
required

name of the data item within case file to retrieve

string

Path

id
required

container id that case instance belongs to

string

Responses
HTTP Code Description Schema

200

successful operation

object

404

Case instance not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/cases/instances/string/caseFile/string
Example HTTP response
Response 200
{ }

Adds new comment to given case instance

POST /server/containers/{id}/cases/instances/{caseId}/comments
Parameters
Type Name Description Schema

Path

caseId
required

identifier of the case instance

string

Path

id
required

container id that case instance belongs to

string

Query

author
optional

optional user id to be used instead of authenticated user - only when bypass authenticated user is enabled

string

Query

restrictedTo
optional

optional role name(s) that given comment should be restricted to

< string > array(multi)

Body

body
required

actual content of the comment to be added as String

string

Responses
HTTP Code Description Schema

404

Case instance not found

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/cases/instances/string/comments
Request body

Retrieves comments from case instance

GET /server/containers/{id}/cases/instances/{caseId}/comments
Parameters
Type Name Description Schema Default

Path

caseId
required

identifier of the case instance

string

Path

id
required

container id that case instance belongs to

string

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Query

sort
optional

optional sort column, no default

string

Responses
HTTP Code Description Schema

200

successful operation

404

Case instance not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/cases/instances/string/comments
Example HTTP response
Response 200
{
  "comments" : [ {
    "id" : "string",
    "author" : "string",
    "text" : "string",
    "added-at" : "1970-01-01T00:00:00Z",
    "restricted-to" : [ "string" ]
  } ]
}

Updates comment within case instance

PUT /server/containers/{id}/cases/instances/{caseId}/comments/{caseCommentId}
Parameters
Type Name Description Schema

Path

caseCommentId
required

identifier of the comment to be updated

string

Path

caseId
required

identifier of the case instance

string

Path

id
required

container id that case instance belongs to

string

Query

author
optional

optional user id to be used instead of authenticated user - only when bypass authenticated user is enabled

string

Query

restrictedTo
optional

optional role name(s) that given comment should be restricted to

< string > array(multi)

Body

body
required

actual content of the comment to be updated to as String

string

Responses
HTTP Code Description Schema

404

Case instance not found

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/cases/instances/string/comments/string
Request body

Removes given comment from case instance

DELETE /server/containers/{id}/cases/instances/{caseId}/comments/{caseCommentId}
Parameters
Type Name Description Schema

Path

caseCommentId
required

identifier of the comment to be removed

string

Path

caseId
required

identifier of the case instance

string

Path

id
required

container id that case instance belongs to

string

Responses
HTTP Code Description Schema

404

Case instance not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/cases/instances/string/comments/string

Retrieves milestones from case instance

GET /server/containers/{id}/cases/instances/{caseId}/milestones
Parameters
Type Name Description Schema Default

Path

caseId
required

identifier of the case instance

string

Path

id
required

container id that case instance belongs to

string

Query

achievedOnly
optional

optional flag that allows to control which milestones to load - achieved only or actives ones too, defaults to true

boolean

"true"

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Responses
HTTP Code Description Schema

200

successful operation

404

Case instance not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/cases/instances/string/milestones
Example HTTP response
Response 200
{
  "milestones" : [ {
    "milestone-name" : "string",
    "milestone-id" : "string",
    "milestone-achieved" : true,
    "milestone-achieved-at" : "1970-01-01T00:00:00Z",
    "milestone-status" : "string"
  } ]
}

Retrieves node instances from case instance

GET /server/containers/{id}/cases/instances/{caseId}/nodes/instances
Parameters
Type Name Description Schema Default

Path

caseId
required

identifier of the case instance

string

Path

id
required

container id that case instance belongs to

string

Query

completed
optional

optional flag that allows to control which node instances to load - active or completed, defaults to false loading only active ones

boolean

"false"

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Responses
HTTP Code Description Schema

200

successful operation

404

Case instance not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/cases/instances/string/nodes/instances
Example HTTP response
Response 200
{
  "node-instance" : [ {
    "node-instance-id" : 0,
    "node-name" : "string",
    "process-instance-id" : 0,
    "work-item-id" : 0,
    "container-id" : "string",
    "start-date" : "1970-01-01T00:00:00Z",
    "node-id" : "string",
    "node-type" : "string",
    "node-connection" : "string",
    "node-completed" : true,
    "reference-id" : 0,
    "sla-compliance" : 0,
    "sla-due-date" : "1970-01-01T00:00:00Z"
  } ]
}

Retrieves process instances that compose complete case instance

GET /server/containers/{id}/cases/instances/{caseId}/processes/instances
Parameters
Type Name Description Schema Default

Path

caseId
required

identifier of the case instance

string

Path

id
required

container id that case instance belongs to

string

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Query

sort
optional

optional sort column, no default

string

Query

sortOrder
optional

optional sort direction (asc, desc) - defaults to asc

boolean

"true"

Query

status
optional

optional process instance status (active, completed, aborted) - defaults ot active (1) only

< enum (1, 2, 3) > array(multi)

Responses
HTTP Code Description Schema

200

successful operation

404

Case instance not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/cases/instances/string/processes/instances
Example HTTP response
Response 200
{
  "process-instance" : [ {
    "process-instance-id" : 0,
    "process-id" : "string",
    "process-name" : "string",
    "process-version" : "string",
    "process-instance-state" : 0,
    "container-id" : "string",
    "initiator" : "string",
    "start-date" : "1970-01-01T00:00:00Z",
    "process-instance-desc" : "string",
    "correlation-key" : "string",
    "parent-instance-id" : 0,
    "sla-compliance" : 0,
    "sla-due-date" : "1970-01-01T00:00:00Z",
    "active-user-tasks" : {
      "task-summary" : [ {
        "task-id" : 0,
        "task-name" : "string",
        "task-subject" : "string",
        "task-description" : "string",
        "task-status" : "string",
        "task-priority" : 0,
        "task-is-skipable" : true,
        "task-actual-owner" : "string",
        "task-created-by" : "string",
        "task-created-on" : "1970-01-01T00:00:00Z",
        "task-activation-time" : "1970-01-01T00:00:00Z",
        "task-expiration-time" : "1970-01-01T00:00:00Z",
        "task-proc-inst-id" : 0,
        "task-proc-def-id" : "string",
        "task-container-id" : "string",
        "task-parent-id" : 0
      } ]
    },
    "process-instance-variables" : {
      "string" : "object"
    }
  } ]
}

Adds dynamic subprocess identified by process id to case instance

POST /server/containers/{id}/cases/instances/{caseId}/processes/{pId}
Parameters
Type Name Description Schema

Path

caseId
required

identifier of the case instance

string

Path

id
required

container id that case instance belongs to

string

Path

pId
required

process id of the subprocess to be added

string

Body

body
required

data for dynamic subprocess

string

Responses
HTTP Code Description Schema

404

Case instance not found

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/cases/instances/string/processes/string
Request body
{
    "age": 25,
    "person": {
        "Person": {
            "name": "john"
        }
    }
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<map-type>
    <entries>
        <entry>
            <key>age</key>
            <value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema"
                    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">25</value>
        </entry>
        <entry>
            <key>person</key>
            <value xsi:type="person" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <name>john</name>
            </value>
        </entry>
    </entries>
</map-type>

Retrieves role assignments from case instance

GET /server/containers/{id}/cases/instances/{caseId}/roles
Parameters
Type Name Description Schema

Path

caseId
required

identifier of the case instance

string

Path

id
required

container id that case instance belongs to

string

Responses
HTTP Code Description Schema

200

successful operation

404

Case instance not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/cases/instances/string/roles
Example HTTP response
Response 200
{
  "role-assignments" : [ {
    "name" : "string",
    "users" : [ "string" ],
    "groups" : [ "string" ]
  } ]
}

Adds new role assignment for given case, it can be either user or group based assignment

PUT /server/containers/{id}/cases/instances/{caseId}/roles/{caseRoleName}
Parameters
Type Name Description Schema

Path

caseId
required

identifier of the case instance

string

Path

caseRoleName
required

name of the case role the assignment should be set

string

Path

id
required

container id that case instance belongs to

string

Query

group
required

group to be aded to case role for given case instance

string

Query

user
required

user to be aded to case role for given case instance

string

Responses
HTTP Code Description Schema

404

Case instance not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/cases/instances/string/roles/string?group=string&user=string

Removes role assignment from user or group for given case instance

DELETE /server/containers/{id}/cases/instances/{caseId}/roles/{caseRoleName}
Parameters
Type Name Description Schema

Path

caseId
required

identifier of the case instance

string

Path

caseRoleName
required

name of the case role the assignment should be removed

string

Path

id
required

container id that case instance belongs to

string

Query

group
required

group to be removed from case role for given case instance

string

Query

user
required

user to be removed from case role for given case instance

string

Responses
HTTP Code Description Schema

404

Case instance not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/cases/instances/string/roles/string?group=string&user=string

Retrieves stages from case instance

GET /server/containers/{id}/cases/instances/{caseId}/stages
Parameters
Type Name Description Schema Default

Path

caseId
required

identifier of the case instance

string

Path

id
required

container id that case instance belongs to

string

Query

activeOnly
optional

optional flag that allows to control which stages to load - active only or completed ones too, defaults to true

boolean

"true"

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Responses
HTTP Code Description Schema

200

successful operation

404

Case instance not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/cases/instances/string/stages
Example HTTP response
Response 200
{
  "stages" : [ {
    "stage-name" : "string",
    "stage-id" : "string",
    "stage-status" : "string",
    "adhoc-fragments" : [ {
      "name" : "string",
      "type" : "string"
    } ],
    "active-nodes" : [ {
      "node-instance-id" : 0,
      "node-name" : "string",
      "process-instance-id" : 0,
      "work-item-id" : 0,
      "container-id" : "string",
      "start-date" : "1970-01-01T00:00:00Z",
      "node-id" : "string",
      "node-type" : "string",
      "node-connection" : "string",
      "node-completed" : true,
      "reference-id" : 0,
      "sla-compliance" : 0,
      "sla-due-date" : "1970-01-01T00:00:00Z"
    } ]
  } ]
}

Adds dynamic subprocess identified by process id to stage within case instance

POST /server/containers/{id}/cases/instances/{caseId}/stages/{caseStageId}/processes/{pId}
Parameters
Type Name Description Schema

Path

caseId
required

identifier of the case instance

string

Path

caseStageId
required

identifier of the stage within case instance where dynamic subprocess should be added

string

Path

id
required

container id that case instance belongs to

string

Path

pId
required

process id of the subprocess to be added

string

Body

body
required

data for dynamic subprocess

string

Responses
HTTP Code Description Schema

404

Case instance not found

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/cases/instances/string/stages/string/processes/string
Request body
{
    "age": 25,
    "person": {
        "Person": {
            "name": "john"
        }
    }
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<map-type>
    <entries>
        <entry>
            <key>age</key>
            <value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema"
                    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">25</value>
        </entry>
        <entry>
            <key>person</key>
            <value xsi:type="person" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <name>john</name>
            </value>
        </entry>
    </entries>
</map-type>

Adds dynamic task (user or service depending on the payload) to given stage within case instance

POST /server/containers/{id}/cases/instances/{caseId}/stages/{caseStageId}/tasks
Parameters
Type Name Description Schema

Path

caseId
required

identifier of the case instance

string

Path

caseStageId
required

identifier of the stage within case instance where dynamic task should be added

string

Path

id
required

container id that case instance belongs to

string

Body

body
required

data for dynamic task (it represents task specification that drives the selection of the type of task)

string

Responses
HTTP Code Description Schema

404

Case instance not found

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/cases/instances/string/stages/string/tasks
Request body
{
    "age": 25,
    "person": {
        "Person": {
            "name": "john"
        }
    }
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<map-type>
    <entries>
        <entry>
            <key>age</key>
            <value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema"
                    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">25</value>
        </entry>
        <entry>
            <key>person</key>
            <value xsi:type="person" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <name>john</name>
            </value>
        </entry>
    </entries>
</map-type>

Triggers ad hoc fragment in stage within case instance with optional data

PUT /server/containers/{id}/cases/instances/{caseId}/stages/{caseStageId}/tasks/{nodeName}
Parameters
Type Name Description Schema

Path

caseId
required

identifier of the case instance

string

Path

caseStageId
required

identifier of the stage within case instance where adhoc fragment should be triggered

string

Path

id
required

container id that case instance belongs to

string

Path

nodeName
required

name of the adhoc fragment to be triggered

string

Body

body
optional

optional data to be given when triggering adhoc fragment

string

Responses
HTTP Code Description Schema

404

Case instance not found

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/cases/instances/string/stages/string/tasks/string
Request body
{
    "age": 25,
    "person": {
        "Person": {
            "name": "john"
        }
    }
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<map-type>
    <entries>
        <entry>
            <key>age</key>
            <value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema"
                    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">25</value>
        </entry>
        <entry>
            <key>person</key>
            <value xsi:type="person" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <name>john</name>
            </value>
        </entry>
    </entries>
</map-type>

Adds dynamic task (user or service depending on the payload) to case instance

POST /server/containers/{id}/cases/instances/{caseId}/tasks
Parameters
Type Name Description Schema

Path

caseId
required

identifier of the case instance

string

Path

id
required

container id that case instance belongs to

string

Body

body
required

data for dynamic task (it represents task specification that drives the selection of the type of task)

string

Responses
HTTP Code Description Schema

404

Case instance not found

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/cases/instances/string/tasks
Request body
{
    "age": 25,
    "person": {
        "Person": {
            "name": "john"
        }
    }
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<map-type>
    <entries>
        <entry>
            <key>age</key>
            <value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema"
                    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">25</value>
        </entry>
        <entry>
            <key>person</key>
            <value xsi:type="person" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <name>john</name>
            </value>
        </entry>
    </entries>
</map-type>

Triggers ad hoc fragment in case instance with optional data

PUT /server/containers/{id}/cases/instances/{caseId}/tasks/{nodeName}
Parameters
Type Name Description Schema

Path

caseId
required

identifier of the case instance

string

Path

id
required

container id that case instance belongs to

string

Path

nodeName
required

name of the adhoc fragment to be triggered

string

Body

body
optional

optional data to be given when triggering adhoc fragment

string

Responses
HTTP Code Description Schema

404

Case instance not found

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/cases/instances/string/tasks/string
Request body
{
    "age": 25,
    "person": {
        "Person": {
            "name": "john"
        }
    }
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<map-type>
    <entries>
        <entry>
            <key>age</key>
            <value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema"
                    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">25</value>
        </entry>
        <entry>
            <key>person</key>
            <value xsi:type="person" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <name>john</name>
            </value>
        </entry>
    </entries>
</map-type>

Starts new case instance of given case definition within given container with optional initial CaseFile (that provides variables and case role assignment)

POST /server/containers/{id}/cases/{caseDefId}/instances
Parameters
Type Name Description Schema

Path

caseDefId
required

case definition id that new instance should be created from

string

Path

id
required

container id where the case definition resides

string

Body

body
optional

optional CaseFile with variables and/or case role assignments

string

Responses
HTTP Code Description Schema

201

successful operation

string

404

Case definition or Container Id not found

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/cases/string/instances
Request body
{
  "case-data" : {
    "car" : "ford"
  },
  "case-user-assignments" : {
    "insured" : "yoda",
    "insuranceRepresentative" : "john"
  },
  "case-group-assignments" : { },
  "case-data-restrictions" : { }
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<case-file>
    <data>
        <entry>
            <key>car</key>
            <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">ford</value>
        </entry>
    </data>
    <userAssignments>
        <entry>
            <key>insured</key>
            <value>yoda</value>
        </entry>
        <entry>
            <key>insuranceRepresentative</key>
            <value>john</value>
        </entry>
    </userAssignments>
    <groupAssignments/>
    <accessRestrictions/>
</case-file>
Example HTTP response
Response 201
"string"

Retrieves case instances for given case definition only, allows to filter by case instance status and applies pagination

GET /server/containers/{id}/cases/{caseDefId}/instances
Parameters
Type Name Description Schema Default

Path

caseDefId
required

case definition id that should be used to filter case instances

string

Path

id
required

container id that should be used to filter case instances

string

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Query

sort
optional

optional sort column, no default

string

Query

sortOrder
optional

optional sort direction (asc, desc) - defaults to asc

boolean

"true"

Query

status
optional

optional case instance status (open, closed, canceled) - defaults ot open (1) only

< enum (open, closed, cancelled) > array(multi)

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/cases/string/instances
Example HTTP response
Response 200
{
  "instances" : [ {
    "case-id" : "string",
    "case-description" : "string",
    "case-owner" : "string",
    "case-status" : 0,
    "case-definition-id" : "string",
    "container-id" : "string",
    "case-started-at" : "1970-01-01T00:00:00Z",
    "case-completed-at" : "1970-01-01T00:00:00Z",
    "case-completion-msg" : "string",
    "case-sla-compliance" : 0,
    "case-sla-due-date" : "1970-01-01T00:00:00Z",
    "case-file" : {
      "case-data" : {
        "string" : "object"
      },
      "case-user-assignments" : {
        "string" : "string"
      },
      "case-group-assignments" : {
        "string" : "string"
      },
      "case-data-restrictions" : {
        "string" : [ "string" ]
      }
    },
    "case-milestones" : [ {
      "milestone-name" : "string",
      "milestone-id" : "string",
      "milestone-achieved" : true,
      "milestone-achieved-at" : "1970-01-01T00:00:00Z",
      "milestone-status" : "string"
    } ],
    "case-stages" : [ {
      "stage-name" : "string",
      "stage-id" : "string",
      "stage-status" : "string",
      "adhoc-fragments" : [ {
        "name" : "string",
        "type" : "string"
      } ],
      "active-nodes" : [ {
        "node-instance-id" : 0,
        "node-name" : "string",
        "process-instance-id" : 0,
        "work-item-id" : 0,
        "container-id" : "string",
        "start-date" : "1970-01-01T00:00:00Z",
        "node-id" : "string",
        "node-type" : "string",
        "node-connection" : "string",
        "node-completed" : true,
        "reference-id" : 0,
        "sla-compliance" : 0,
        "sla-due-date" : "1970-01-01T00:00:00Z"
      } ]
    } ],
    "case-roles" : [ {
      "name" : "string",
      "users" : [ "string" ],
      "groups" : [ "string" ]
    } ]
  } ]
}

Reopens case instance with given identifier (case id) by initiating given case definition

PUT /server/containers/{id}/cases/{caseDefId}/instances/{caseId}
Parameters
Type Name Description Schema

Path

caseDefId
required

case definition id that new instance should be created from

string

Path

caseId
required

identifier of the case instance

string

Path

id
required

container id where the case definition resides

string

Body

body
optional

optional CaseFile with variables and/or case role assignments

string

Responses
HTTP Code Description Schema

404

Case instance not found

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/cases/string/instances/string
Request body
{
  "case-data" : {
    "car" : "ford"
  },
  "case-user-assignments" : {
    "insured" : "yoda",
    "insuranceRepresentative" : "john"
  },
  "case-group-assignments" : { },
  "case-data-restrictions" : { }
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<case-file>
    <data>
        <entry>
            <key>car</key>
            <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">ford</value>
        </entry>
    </data>
    <userAssignments>
        <entry>
            <key>insured</key>
            <value>yoda</value>
        </entry>
        <entry>
            <key>insuranceRepresentative</key>
            <value>john</value>
        </entry>
    </userAssignments>
    <groupAssignments/>
    <accessRestrictions/>
</case-file>

Custom Queries :: BPM

Retruns all custom queries defined in the system

GET /server/queries/definitions
Parameters
Type Name Description Schema Default

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/queries/definitions
Example HTTP response
Response 200
{
  "queries" : [ {
    "query-name" : "string",
    "query-source" : "string",
    "query-expression" : "string",
    "query-target" : "string",
    "query-columns" : {
      "string" : "string"
    }
  } ]
}

Queries using query definition identified by queryName filtered by container. Maps the result to concrete objects based on provided mapper. Query is additional altered by the filter spec and/or builder

POST /server/queries/definitions/containers/{id}/query/{queryName}/filtered-data
Parameters
Type Name Description Schema Default

Path

id
required

container id to filter queries

string

Path

queryName
required

identifier of the query definition to be used for query

string

Query

builder
optional

optional identifier of the query builder to be used for query conditions

string

Query

mapper
required

identifier of the query mapper to be used when transforming results

string

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Body

body
optional

optional query filter specification represented as QueryFilterSpec

string

Responses
HTTP Code Description Schema

200

successful operation

object

400

Query parameters or filter spec provide invalid conditions

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/queries/definitions/containers/string/query/string/filtered-data?mapper=string
Request body
{
  "order-by" : null,
  "order-asc" : false,
  "query-params" : [ {
    "cond-column" : "processinstanceid",
    "cond-operator" : "GREATER_THAN",
    "cond-values" : [ 9 ]
  } ],
  "result-column-mapping" : null,
  "order-by-clause" : null
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<query-filter-spec>
    <order-asc>false</order-asc>
    <query-params>
        <cond-column>processinstanceid</cond-column>
        <cond-operator>GREATER_THAN</cond-operator>
        <cond-values xsi:type="xs:long" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">9</cond-values>
    </query-params>
</query-filter-spec>
Example HTTP response
Response 200
{ }

Registers new query definition in the system with given queryName

POST /server/queries/definitions/{queryName}
Parameters
Type Name Description Schema

Path

queryName
required

identifier of the query definition to be registered

string

Body

body
required

query definition represented as QueryDefinition

string

Responses
HTTP Code Description Schema

201

successful operation

409

Query with given name already exists

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/queries/definitions/string
Request body
{
  "query-name" : "allProcessInstances",
  "query-source" : "jdbc/jbpm-ds",
  "query-expression" : "select * from ProcessInstanceLog where status = 1",
  "query-target" : "PROCESS",
  "query-columns" : null
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<query-definition>
    <query-name>allProcessInstances</query-name>
    <query-source>jdbc/jbpm-ds</query-source>
    <query-expression>select * from ProcessInstanceLog where status = 1</query-expression>
    <query-target>PROCESS</query-target>
    <columns></columns>
</query-definition>
Example HTTP response
Response 201
{
  "query-name" : "string",
  "query-source" : "string",
  "query-expression" : "string",
  "query-target" : "string",
  "query-columns" : {
    "string" : "string"
  }
}

Retrieves existing query definition from the system with given queryName

GET /server/queries/definitions/{queryName}
Parameters
Type Name Description Schema

Path

queryName
required

identifier of the query definition to be retrieved

string

Responses
HTTP Code Description Schema

200

successful operation

404

Query definition with given name not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/queries/definitions/string
Example HTTP response
Response 200
{
  "query-name" : "string",
  "query-source" : "string",
  "query-expression" : "string",
  "query-target" : "string",
  "query-columns" : {
    "string" : "string"
  }
}

Replaces existing query definition or registers new if not exists in the system with given queryName

PUT /server/queries/definitions/{queryName}
Parameters
Type Name Description Schema

Path

queryName
required

identifier of the query definition to be replaced

string

Body

body
required

query definition represented as QueryDefinition

string

Responses
HTTP Code Description Schema

201

successful operation

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/queries/definitions/string
Request body
{
  "query-name" : "allProcessInstances",
  "query-source" : "jdbc/jbpm-ds",
  "query-expression" : "select * from ProcessInstanceLog where status = 1",
  "query-target" : "PROCESS",
  "query-columns" : null
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<query-definition>
    <query-name>allProcessInstances</query-name>
    <query-source>jdbc/jbpm-ds</query-source>
    <query-expression>select * from ProcessInstanceLog where status = 1</query-expression>
    <query-target>PROCESS</query-target>
    <columns></columns>
</query-definition>
Example HTTP response
Response 201
{
  "query-name" : "string",
  "query-source" : "string",
  "query-expression" : "string",
  "query-target" : "string",
  "query-columns" : {
    "string" : "string"
  }
}

Deletes existing query definition from the system with given queryName

DELETE /server/queries/definitions/{queryName}
Parameters
Type Name Description Schema

Path

queryName
required

identifier of the query definition to be deleted

string

Responses
HTTP Code Description Schema

404

Query definition with given name not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/queries/definitions/string

Queries using query definition identified by queryName. Maps the result to concrete objects based on provided mapper.

GET /server/queries/definitions/{queryName}/data
Parameters
Type Name Description Schema Default

Path

queryName
required

identifier of the query definition to be used for query

string

Query

mapper
required

identifier of the query mapper to be used when transforming results

string

Query

orderBy
optional

optional sort order

string

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Responses
HTTP Code Description Schema

200

successful operation

< object > array

404

Query definition with given name not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/queries/definitions/string/data?mapper=string
Example HTTP response
Response 200
[ "object" ]

Queries using query definition identified by queryName. Maps the result to concrete objects based on provided mapper. Query is additional altered by the filter spec and/or builder

POST /server/queries/definitions/{queryName}/filtered-data
Parameters
Type Name Description Schema Default

Path

queryName
required

identifier of the query definition to be used for query

string

Query

builder
optional

optional identifier of the query builder to be used for query conditions

string

Query

mapper
required

identifier of the query mapper to be used when transforming results

string

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Body

body
optional

optional query filter specification represented as QueryFilterSpec

string

Responses
HTTP Code Description Schema

200

successful operation

object

400

Query parameters or filter spec provide invalid conditions

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/queries/definitions/string/filtered-data?mapper=string
Request body
{
  "order-by" : null,
  "order-asc" : false,
  "query-params" : [ {
    "cond-column" : "processinstanceid",
    "cond-operator" : "GREATER_THAN",
    "cond-values" : [ 9 ]
  } ],
  "result-column-mapping" : null,
  "order-by-clause" : null
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<query-filter-spec>
    <order-asc>false</order-asc>
    <query-params>
        <cond-column>processinstanceid</cond-column>
        <cond-operator>GREATER_THAN</cond-operator>
        <cond-values xsi:type="xs:long" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">9</cond-values>
    </query-params>
</query-filter-spec>
Example HTTP response
Response 200
{ }

Decision Service :: DMN

Evaluates decisions for given imput

POST /server/containers/{id}/dmn
Parameters
Type Name Description Schema

Path

id
required

Container id to be used to evaluate decisions on

string

Body

body
required

DMN context to be used while evaluation decisions as DMNContextKS type

string

Responses
HTTP Code Description Schema

200

successful operation

404

Container not found

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/dmn
Request body
Example HTTP response
Response 200
{
  "type" : "SUCCESS",
  "msg" : "string"
}

Retrieves DMN model for given container

GET /server/containers/{id}/dmn
Parameters
Type Name Description Schema

Path

id
required

Container id that modesl should be loaded from

string

Responses
HTTP Code Description Schema

200

successful operation

404

Models or container not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/dmn
Example HTTP response
Response 200
{
  "type" : "SUCCESS",
  "msg" : "string"
}

Documents :: BPM

Creates new document based on given content (body)

POST /server/documents
Parameters
Type Name Description Schema

Body

body
required

document content represented as DocumentInstance

string

Responses
HTTP Code Description Schema

201

successful operation

string

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/documents
Request body
{
  "document-name" : "first document",
  "document-link" : null,
  "document-size" : 17,
  "document-last-mod" : {
    "java.util.Date" : 1539936629148
  },
  "document-content" : "anVzdCB0ZXh0IGNvbnRlbnQ="
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<document-instance>
    <document-name>first document</document-name>
    <document-size>17</document-size>
    <document-last-mod>2018-10-19T10:10:28.914+02:00</document-last-mod>
    <document-content>anVzdCB0ZXh0IGNvbnRlbnQ=</document-content>
</document-instance>
Example HTTP response
Response 201
"string"

Retrieves documents that are stored in the system, with pagination

GET /server/documents
Parameters
Type Name Description Schema Default

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/documents
Example HTTP response
Response 200
{
  "document-instances" : [ {
    "document-id" : "string",
    "document-name" : "string",
    "document-link" : "string",
    "document-size" : 0,
    "document-last-mod" : "1970-01-01T00:00:00Z",
    "document-content" : [ "Ynl0ZQ==" ]
  } ]
}

Retrieves document identified by given documentId

GET /server/documents/{documentId}
Parameters
Type Name Description Schema

Path

documentId
required

document id of a document that should be retruned

string

Responses
HTTP Code Description Schema

200

successful operation

404

Document with given id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/documents/string
Example HTTP response
Response 200
{
  "document-id" : "string",
  "document-name" : "string",
  "document-link" : "string",
  "document-size" : 0,
  "document-last-mod" : "1970-01-01T00:00:00Z",
  "document-content" : [ "Ynl0ZQ==" ]
}

Updates document identified by given document id based on given content (body)

PUT /server/documents/{documentId}
Parameters
Type Name Description Schema

Path

documentId
required

document id of a document that should be updated

string

Body

body
required

document content represented as DocumentInstance

string

Responses
HTTP Code Description Schema

404

Document with given id not found

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/documents/string
Request body
{
  "document-name" : "first document",
  "document-link" : null,
  "document-size" : 17,
  "document-last-mod" : {
    "java.util.Date" : 1539936629148
  },
  "document-content" : "anVzdCB0ZXh0IGNvbnRlbnQ="
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<document-instance>
    <document-name>first document</document-name>
    <document-size>17</document-size>
    <document-last-mod>2018-10-19T10:10:28.914+02:00</document-last-mod>
    <document-content>anVzdCB0ZXh0IGNvbnRlbnQ=</document-content>
</document-instance>

Deletes document identified by given document id

DELETE /server/documents/{documentId}
Parameters
Type Name Description Schema

Path

documentId
required

document id of a document that should be deleted

string

Responses
HTTP Code Description Schema

404

Document with given id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/documents/string

Retrieves document’s content identified by given documentId

GET /server/documents/{documentId}/content
Parameters
Type Name Description Schema

Path

documentId
required

document id of a document that content should be retruned from

string

Responses
HTTP Code Description Schema

200

successful operation

< string (byte) > array

404

Document with given id not found

No Content

500

Unexpected error

No Content

Produces
  • application/octet-stream

Example HTTP request
Request path
/server/documents/string/content
Example HTTP response
Response 200
[ "Ynl0ZQ==" ]

KIE Server :: Core

Retrieves KIE Server information - id, name, location, capabilities, messages

GET /server
Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server
Example HTTP response
Response 200
{
  "type" : "SUCCESS",
  "msg" : "string"
}

Retrieves containers deployed to this server, optionally filtered by group, artifact, version or status

GET /server/containers
Parameters
Type Name Description Schema

Query

artifactId
optional

optional artifactId to filter containers by

string

Query

groupId
optional

optional groupId to filter containers by

string

Query

status
optional

optional status to filter containers by

string

Query

version
optional

optional version to filter containers by

string

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers
Example HTTP response
Response 200
{
  "type" : "SUCCESS",
  "msg" : "string"
}

Retrieves container with given id

GET /server/containers/{id}
Parameters
Type Name Description Schema

Path

id
required

Container id to be retrieved

string

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string
Example HTTP response
Response 200
{
  "type" : "SUCCESS",
  "msg" : "string"
}

Creates (deploys) new KIE container to this server

PUT /server/containers/{id}
Parameters
Type Name Description Schema

Path

id
required

Container id to be assigned to deployed KIE Container

string

Body

body
required

KIE Container resource to be deployed as KieContainerResource

string

Responses
HTTP Code Description Schema

201

successful operation

400

container could not be created

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string
Request body
Example HTTP response
Response 201
{
  "type" : "SUCCESS",
  "msg" : "string"
}

Disposes (undeploys) container with given id

DELETE /server/containers/{id}
Parameters
Type Name Description Schema

Path

id
required

Container id to be disposed (undeployed)

string

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string
Example HTTP response
Response 200
{
  "type" : "SUCCESS",
  "msg" : "string"
}

Updates release id of the KIE container with given id to provided release id

POST /server/containers/{id}/release-id
Parameters
Type Name Description Schema

Path

id
required

Container id that release id should be upgraded

string

Body

body
required

Release Id to be upgraded to as ReleaseId type

string

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/release-id
Request body
Example HTTP response
Response 200
{
  "type" : "SUCCESS",
  "msg" : "string"
}

Retrieves release id of the KIE container with given id

GET /server/containers/{id}/release-id
Parameters
Type Name Description Schema

Path

id
required

Container id that release id should be loaded from

string

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/release-id
Example HTTP response
Response 200
{
  "type" : "SUCCESS",
  "msg" : "string"
}

Updates scanner for given container

POST /server/containers/{id}/scanner
Parameters
Type Name Description Schema

Path

id
required

Container id for scanner to be updated

string

Body

body
required

Scanner information given as KieScannerResource type

string

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/scanner
Request body
Example HTTP response
Response 200
{
  "type" : "SUCCESS",
  "msg" : "string"
}

Retrieves scanner information for given container

GET /server/containers/{id}/scanner
Parameters
Type Name Description Schema

Path

id
required

Container id for scanner to be loaded

string

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/scanner
Example HTTP response
Response 200
{
  "type" : "SUCCESS",
  "msg" : "string"
}

Activates (previously deactivated) KIE container on this server

PUT /server/containers/{id}/status/activated
Parameters
Type Name Description Schema

Path

id
required

Container id of deployed KIE Container

string

Responses
HTTP Code Description Schema

201

successful operation

400

container could not be activated

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/status/activated
Example HTTP response
Response 201
{
  "type" : "SUCCESS",
  "msg" : "string"
}

Deactivates (previously started) KIE container on this server

PUT /server/containers/{id}/status/deactivated
Parameters
Type Name Description Schema

Path

id
required

Container id of deployed KIE Container

string

Responses
HTTP Code Description Schema

201

successful operation

400

container could not be deactivated

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/status/deactivated
Example HTTP response
Response 201
{
  "type" : "SUCCESS",
  "msg" : "string"
}

Liveness check for KIE Server that validates both kie server and all extensions, optionally produces report

GET /server/healthcheck
Parameters
Type Name Description Schema Default

Query

report
optional

optional report flag to return detailed report of the check, defaults to false

boolean

"false"

Responses
HTTP Code Description Schema

200

successful operation

< kie-message > array

503

If any of the checks failed

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/healthcheck
Example HTTP response
Response 200
[ {
  "severity" : "INFO",
  "timestamp" : "1970-01-01T00:00:00Z",
  "content" : [ "string" ]
} ]

Readiness check for KIE Server that indicates that server is fully booted and ready to accept requests

GET /server/readycheck
Responses
HTTP Code Description Schema

503

Service not yet available

No Content

Produces
  • text/plain

Example HTTP request
Request path
/server/readycheck

Retrieves server state - configuration that the server is currently running with

GET /server/state
Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/state
Example HTTP response
Response 200
{
  "type" : "SUCCESS",
  "msg" : "string"
}

KIE Server Script :: Core

Executes command script on execution server, usually used as a batch to configure KIE Server

POST /server/config
Parameters
Type Name Description Schema

Body

body
required

command script payload

string

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/config
Request body
Example HTTP response
Response 200
{
  "response" : [ {
    "type" : "SUCCESS",
    "msg" : "string"
  } ]
}

Planning And Solvers :: BRP

Retrieves solvers from given container

GET /server/containers/{id}/solvers
Parameters
Type Name Description Schema

Path

id
required

container id where the solvers reside

string

Responses
HTTP Code Description Schema

200

successful operation

404

Container does not exist or failure in creating solver

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/solvers
Example HTTP response
Response 200
{
  "solver" : [ {
    "container-id" : "string",
    "solver-id" : "string",
    "solver-config-file" : "string",
    "status" : "NOT_SOLVING",
    "score" : {
      "value" : "string"
    },
    "best-solution" : "object"
  } ]
}

Retrieves solver by its identifier from given container

GET /server/containers/{id}/solvers/{solverId}
Parameters
Type Name Description Schema

Path

id
required

container id where the solver resides

string

Path

solverId
required

identifier of the solver

string

Responses
HTTP Code Description Schema

200

successful operation

404

Container does not exist or failure in creating solver

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/solvers/string
Example HTTP response
Response 200
{
  "container-id" : "string",
  "solver-id" : "string",
  "solver-config-file" : "string",
  "status" : "NOT_SOLVING",
  "score" : {
    "value" : "string"
  },
  "best-solution" : "object"
}

Creates solver within given container

PUT /server/containers/{id}/solvers/{solverId}
Parameters
Type Name Description Schema

Path

id
required

container id where the solver config resides

string

Path

solverId
required

identifier of the solver to create

string

Body

body
required

solver instance details as SolverInstance type

string

Responses
HTTP Code Description Schema

200

successful operation

400

Container does not exist or failure in creating solver

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/solvers/string
Request body
Example HTTP response
Response 200
{
  "container-id" : "string",
  "solver-id" : "string",
  "solver-config-file" : "string",
  "status" : "NOT_SOLVING",
  "score" : {
    "value" : "string"
  },
  "best-solution" : "object"
}

Disposes given solver

DELETE /server/containers/{id}/solvers/{solverId}
Parameters
Type Name Description Schema

Path

id
required

container id where the solver resides

string

Path

solverId
required

identifier of the solver

string

Responses
HTTP Code Description Schema

404

Container does not exist or failure in creating solver

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/solvers/string

Retrieves best solution from solver within container

GET /server/containers/{id}/solvers/{solverId}/bestsolution
Parameters
Type Name Description Schema

Path

id
required

container id where the solver resides

string

Path

solverId
required

identifier of the solver

string

Responses
HTTP Code Description Schema

200

successful operation

404

Container does not exist or failure in creating solver

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/solvers/string/bestsolution
Example HTTP response
Response 200
{
  "container-id" : "string",
  "solver-id" : "string",
  "solver-config-file" : "string",
  "status" : "NOT_SOLVING",
  "score" : {
    "value" : "string"
  },
  "best-solution" : "object"
}

Adds problem fact changes to given solver

POST /server/containers/{id}/solvers/{solverId}/problemfactchanges
Parameters
Type Name Description Schema

Path

id
required

container id where the solver resides

string

Path

solverId
required

identifier of the solver

string

Body

body
required

Problem fact changes, either single one or a list of them

string

Responses
HTTP Code Description Schema

400

Container does not exist or failure in creating solver

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/solvers/string/problemfactchanges
Request body

Retrieves status if problem fact changes have been processed in given solver

GET /server/containers/{id}/solvers/{solverId}/problemfactchanges/processed
Parameters
Type Name Description Schema

Path

id
required

container id where the solver resides

string

Path

solverId
required

identifier of the solver

string

Responses
HTTP Code Description Schema

200

successful operation

boolean

404

Container does not exist or failure in creating solver

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/solvers/string/problemfactchanges/processed
Example HTTP response
Response 200
true

Solves given planning problem with given solver

POST /server/containers/{id}/solvers/{solverId}/state/solving
Parameters
Type Name Description Schema

Path

id
required

container id where the solver resides

string

Path

solverId
required

identifier of the solver

string

Body

body
required

planning problem

string

Responses
HTTP Code Description Schema

404

Container does not exist or failure in creating solver

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/solvers/string/state/solving
Request body

Terminates early running solver with given id within container

POST /server/containers/{id}/solvers/{solverId}/state/terminating-early
Parameters
Type Name Description Schema

Path

id
required

container id where the solver resides

string

Path

solverId
required

identifier of the solver

string

Responses
HTTP Code Description Schema

400

Container does not exist or failure in creating solver

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/solvers/string/state/terminating-early

Process And Task Definitions :: BPM

Retrieves process definition identified by given process id within given container

GET /server/containers/{id}/processes/definitions/{pId}
Parameters
Type Name Description Schema

Path

id
required

container id where the process definition resides

string

Path

pId
required

process id that the definition should be retrieved for

string

Responses
HTTP Code Description Schema

200

successful operation

404

Process or Container Id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/processes/definitions/string
Example HTTP response
Response 200
{
  "associatedEntities" : {
    "string" : [ "string" ]
  },
  "serviceTasks" : {
    "string" : "string"
  },
  "processVariables" : {
    "string" : "string"
  },
  "reusableSubProcesses" : [ "string" ],
  "process-id" : "string",
  "process-name" : "string",
  "process-version" : "string",
  "package" : "string",
  "container-id" : "string",
  "dynamic" : true
}

Retrieves actors and groups that are involved in given process and container

GET /server/containers/{id}/processes/definitions/{pId}/entities
Parameters
Type Name Description Schema

Path

id
required

container id where the process definition resides

string

Path

pId
required

process id that the involved actors and groups should be retrieved from

string

Responses
HTTP Code Description Schema

200

successful operation

404

Process or Container Id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/processes/definitions/string/entities
Example HTTP response
Response 200
{
  "associatedEntities" : {
    "string" : [ "string" ]
  }
}

Retrieves sub process definitions that are defined in given process within given container

GET /server/containers/{id}/processes/definitions/{pId}/subprocesses
Parameters
Type Name Description Schema

Path

id
required

container id where the process definition resides

string

Path

pId
required

process id that subprocesses should be retrieved from

string

Responses
HTTP Code Description Schema

200

successful operation

404

Process or Container Id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/processes/definitions/string/subprocesses
Example HTTP response
Response 200
{
  "subProcesses" : [ "string" ]
}

Retrieves service tasks definitions that are present in given process and container

GET /server/containers/{id}/processes/definitions/{pId}/tasks/service
Parameters
Type Name Description Schema

Path

id
required

container id where the process definition resides

string

Path

pId
required

process id that the service task definitions should be retrieved from

string

Responses
HTTP Code Description Schema

200

successful operation

404

Process or Container Id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/processes/definitions/string/tasks/service
Example HTTP response
Response 200
{
  "serviceTasks" : {
    "string" : "string"
  }
}

Retrieves user tasks definitions that are present in given process and container

GET /server/containers/{id}/processes/definitions/{pId}/tasks/users
Parameters
Type Name Description Schema

Path

id
required

container id where the process definition resides

string

Path

pId
required

process id that the user task definitions should be retrieved from

string

Responses
HTTP Code Description Schema

200

successful operation

404

Process or Container Id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/processes/definitions/string/tasks/users
Example HTTP response
Response 200
{
  "task" : [ {
    "associatedEntities" : [ "string" ],
    "taskInputMappings" : {
      "string" : "string"
    },
    "taskOutputMappings" : {
      "string" : "string"
    },
    "task-id" : "string",
    "task-name" : "string",
    "task-priority" : 0,
    "task-comment" : "string",
    "task-created-by" : "string",
    "task-skippable" : true,
    "task-form-name" : "string"
  } ]
}

Retrieves input variables defined on a given user task

GET /server/containers/{id}/processes/definitions/{pId}/tasks/users/{taskName}/inputs
Parameters
Type Name Description Schema

Path

id
required

container id where the process definition resides

string

Path

pId
required

process id that given task belongs to

string

Path

taskName
required

task name that input variable definitions should be retrieved for

string

Responses
HTTP Code Description Schema

200

successful operation

404

Process or Container Id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/processes/definitions/string/tasks/users/string/inputs
Example HTTP response
Response 200
{
  "taskInputs" : {
    "string" : "string"
  }
}

Retrieves output variables defined on a given user task

GET /server/containers/{id}/processes/definitions/{pId}/tasks/users/{taskName}/outputs
Parameters
Type Name Description Schema

Path

id
required

container id where the process definition resides

string

Path

pId
required

process id that given task belongs to

string

Path

taskName
required

task name that output variable definitions should be retrieved for

string

Responses
HTTP Code Description Schema

200

successful operation

404

Process or Container Id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/processes/definitions/string/tasks/users/string/outputs
Example HTTP response
Response 200
{
  "taskOutputs" : {
    "string" : "string"
  }
}

Retrieves process variables definitions that are present in given process and container

GET /server/containers/{id}/processes/definitions/{pId}/variables
Parameters
Type Name Description Schema

Path

id
required

container id where the process definition resides

string

Path

pId
required

process id that the variable definitions should be retrieved from

string

Responses
HTTP Code Description Schema

200

successful operation

404

Process or Container Id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/processes/definitions/string/variables
Example HTTP response
Response 200
{
  "variables" : {
    "string" : "string"
  }
}

Process And Task Forms :: BPM

Retrieves form for case definition within a container that is completely rendered and ready for use

GET /server/containers/{id}/forms/cases/{caseDefId}/content
Parameters
Type Name Description Schema Default

Path

caseDefId
required

identifier of case definition that form should be fetched for

string

Path

id
required

container id that case definition belongs to

string

Query

renderer
optional

optional renderer name that the form should be rendered with

string

"patternfly"

Responses
HTTP Code Description Schema

200

successful operation

string

404

Case, form or Container Id not found

No Content

500

Unexpected error

No Content

Produces
  • text/html

Example HTTP request
Request path
/server/containers/string/forms/cases/string/content
Example HTTP response
Response 200
"string"

Retrieves form for process definition within a container

GET /server/containers/{id}/forms/processes/{pId}
Parameters
Type Name Description Schema Default

Path

id
required

container id that process definition belongs to

string

Path

pId
required

identifier of process definition that form should be fetched for

string

Query

filter
optional

optional filter flag if form should be filtered or returned as is

boolean

Query

lang
optional

optional language that the form should be found for

string

"en"

Query

marshallContent
optional

optional marshall content flag if the content should be transformed or not, defaults to true

boolean

"true"

Query

type
optional

optional type of the form, defaults to ANY so system will find the most current one

string

"ANY"

Responses
HTTP Code Description Schema

200

successful operation

string

404

Process definition, form or Container Id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/forms/processes/string
Example HTTP response
Response 200
"string"

Retrieves form for process definition within a container that is completely rendered and ready for use

GET /server/containers/{id}/forms/processes/{pId}/content
Parameters
Type Name Description Schema Default

Path

id
required

container id that process definition belongs to

string

Path

pId
required

identifier of process definition that form should be fetched for

string

Query

renderer
optional

optional renderer name that the form should be rendered with

string

"patternfly"

Responses
HTTP Code Description Schema

200

successful operation

string

404

Process, form or Container Id not found

No Content

500

Unexpected error

No Content

Produces
  • text/html

Example HTTP request
Request path
/server/containers/string/forms/processes/string/content
Example HTTP response
Response 200
"string"

Retrieves form for task instance within a container

GET /server/containers/{id}/forms/tasks/{tInstanceId}
Parameters
Type Name Description Schema Default

Path

id
required

container id that task instance belongs to

string

Path

tInstanceId
required

identifier of task instance that form should be fetched for

integer (int64)

Query

filter
optional

optional filter flag if form should be filtered or returned as is

boolean

Query

lang
optional

optional language that the form should be found for

string

"en"

Query

marshallContent
optional

optional marshall content flag if the content should be transformed or not, defaults to true

boolean

"true"

Query

type
optional

optional type of the form, defaults to ANY so system will find the most current one

string

"ANY"

Responses
HTTP Code Description Schema

200

successful operation

string

404

Task, form or Container Id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/forms/tasks/0
Example HTTP response
Response 200
"string"

Retrieves form for task instance within a container that is completely rendered and ready for use

GET /server/containers/{id}/forms/tasks/{tInstanceId}/content
Parameters
Type Name Description Schema Default

Path

id
required

container id that task instance belongs to

string

Path

tInstanceId
required

identifier of task instance that form should be fetched for

integer (int64)

Query

renderer
optional

optional renderer name that the form should be rendered with

string

"patternfly"

Responses
HTTP Code Description Schema

200

successful operation

string

404

Task, form or Container Id not found

No Content

500

Unexpected error

No Content

Produces
  • text/html

Example HTTP request
Request path
/server/containers/string/forms/tasks/0/content
Example HTTP response
Response 200
"string"

Process Definition And Instance Images :: BPM

Retrieves process instance image

GET /server/containers/{id}/images/processes/instances/{pInstanceId}
Parameters
Type Name Description Schema

Path

id
required

container id that process instance belongs to

string

Path

pInstanceId
required

identifier of the process instance that image should be loaded for

integer (int64)

Responses
HTTP Code Description Schema

200

successful operation

string

404

Process instance, image or Container Id not found

No Content

500

Unexpected error

No Content

Produces
  • application/svg+xml

Example HTTP request
Request path
/server/containers/string/images/processes/instances/0
Example HTTP response
Response 200
"string"

Retrieves process definition image

GET /server/containers/{id}/images/processes/{pId}
Parameters
Type Name Description Schema

Path

id
required

container id that process definition belongs to

string

Path

pId
required

identifier of the process definition that image should be loaded for

string

Responses
HTTP Code Description Schema

200

successful operation

string

404

Process definition, image or Container Id not found

No Content

500

Unexpected error

No Content

Produces
  • application/svg+xml

Example HTTP request
Request path
/server/containers/string/images/processes/string
Example HTTP response
Response 200
"string"

Process Instances :: BPM

Retrieves process definitions that belong to given container

GET /server/containers/{id}/processes
Parameters
Type Name Description Schema Default

Path

id
required

container id that process instance belongs to

string

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Query

sort
optional

optional sort column, no default

string

Query

sortOrder
optional

optional sort direction (asc, desc) - defaults to asc

boolean

"true"

Responses
HTTP Code Description Schema

200

successful operation

404

Container Id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/processes
Example HTTP response
Response 200
{
  "processes" : [ {
    "associatedEntities" : {
      "string" : [ "string" ]
    },
    "serviceTasks" : {
      "string" : "string"
    },
    "processVariables" : {
      "string" : "string"
    },
    "reusableSubProcesses" : [ "string" ],
    "process-id" : "string",
    "process-name" : "string",
    "process-version" : "string",
    "package" : "string",
    "container-id" : "string",
    "dynamic" : true
  } ]
}

Retrieves process instances that belong to given container

GET /server/containers/{id}/processes/instances
Parameters
Type Name Description Schema Default

Path

id
required

container id that process instance belongs to

string

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Query

sort
optional

optional sort column, no default

string

Query

sortOrder
optional

optional sort direction (asc, desc) - defaults to asc

boolean

"true"

Query

status
optional

optional process instance status (active, completed, aborted) - defaults ot active (1) only

< enum (1, 2, 3) > array(multi)

Responses
HTTP Code Description Schema

200

successful operation

404

Container Id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/processes/instances
Example HTTP response
Response 200
{
  "process-instance" : [ {
    "process-instance-id" : 0,
    "process-id" : "string",
    "process-name" : "string",
    "process-version" : "string",
    "process-instance-state" : 0,
    "container-id" : "string",
    "initiator" : "string",
    "start-date" : "1970-01-01T00:00:00Z",
    "process-instance-desc" : "string",
    "correlation-key" : "string",
    "parent-instance-id" : 0,
    "sla-compliance" : 0,
    "sla-due-date" : "1970-01-01T00:00:00Z",
    "active-user-tasks" : {
      "task-summary" : [ {
        "task-id" : 0,
        "task-name" : "string",
        "task-subject" : "string",
        "task-description" : "string",
        "task-status" : "string",
        "task-priority" : 0,
        "task-is-skipable" : true,
        "task-actual-owner" : "string",
        "task-created-by" : "string",
        "task-created-on" : "1970-01-01T00:00:00Z",
        "task-activation-time" : "1970-01-01T00:00:00Z",
        "task-expiration-time" : "1970-01-01T00:00:00Z",
        "task-proc-inst-id" : 0,
        "task-proc-def-id" : "string",
        "task-container-id" : "string",
        "task-parent-id" : 0
      } ]
    },
    "process-instance-variables" : {
      "string" : "object"
    }
  } ]
}

Aborts active process instances identified by given list of identifiers

DELETE /server/containers/{id}/processes/instances
Parameters
Type Name Description Schema

Path

id
required

container id that process instance belongs to

string

Query

instanceId
required

list of identifiers of the process instances to be aborted

< integer (int64) > array(multi)

Responses
HTTP Code Description Schema

404

Process instance or Container Id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/processes/instances?instanceId=0

Signals active process instances identified by given ids with singal name and optional event data

POST /server/containers/{id}/processes/instances/signal/{sName}
Parameters
Type Name Description Schema

Path

id
required

container id that process instance belongs to

string

Path

sName
required

signal name to be send to process instance

string

Query

instanceId
required

list of identifiers of the process instances to be signaled

< integer (int64) > array(multi)

Body

body
optional

optional event data - any type can be provided

string

Responses
HTTP Code Description Schema

404

Process instance or Container Id not found

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/processes/instances/signal/string?instanceId=0
Request body
{
    "Person": {
        "name": "john"
    }
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<person>
    <name>john</name>
</person>

Retrieves process instance identified by given id optionally with variables (variables will be loaded only for active process instance)

GET /server/containers/{id}/processes/instances/{pInstanceId}
Parameters
Type Name Description Schema

Path

id
required

container id that process instance belongs to

string

Path

pInstanceId
required

identifier of the process instance to be fetched

integer (int64)

Query

withVars
optional

indicates if process instance variables should be loaded or not

boolean

Responses
HTTP Code Description Schema

200

successful operation

404

Process instance or Container Id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/processes/instances/0
Example HTTP response
Response 200
{
  "process-instance-id" : 0,
  "process-id" : "string",
  "process-name" : "string",
  "process-version" : "string",
  "process-instance-state" : 0,
  "container-id" : "string",
  "initiator" : "string",
  "start-date" : "1970-01-01T00:00:00Z",
  "process-instance-desc" : "string",
  "correlation-key" : "string",
  "parent-instance-id" : 0,
  "sla-compliance" : 0,
  "sla-due-date" : "1970-01-01T00:00:00Z",
  "active-user-tasks" : {
    "task-summary" : [ {
      "task-id" : 0,
      "task-name" : "string",
      "task-subject" : "string",
      "task-description" : "string",
      "task-status" : "string",
      "task-priority" : 0,
      "task-is-skipable" : true,
      "task-actual-owner" : "string",
      "task-created-by" : "string",
      "task-created-on" : "1970-01-01T00:00:00Z",
      "task-activation-time" : "1970-01-01T00:00:00Z",
      "task-expiration-time" : "1970-01-01T00:00:00Z",
      "task-proc-inst-id" : 0,
      "task-proc-def-id" : "string",
      "task-container-id" : "string",
      "task-parent-id" : 0
    } ]
  },
  "process-instance-variables" : {
    "string" : "object"
  }
}

Aborts active process instance identified by given id

DELETE /server/containers/{id}/processes/instances/{pInstanceId}
Parameters
Type Name Description Schema

Path

id
required

container id that process instance belongs to

string

Path

pInstanceId
required

identifier of the process instance to be aborted

integer (int64)

Responses
HTTP Code Description Schema

404

Process instance or Container Id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/processes/instances/0

Retrieves node instances for given process instance. Depending on provided query parameters (activeOnly or completedOnly) will return active and/or completes nodes

GET /server/containers/{id}/processes/instances/{pInstanceId}/nodes/instances
Parameters
Type Name Description Schema Default

Path

id
required

container id that process instance belongs to

string

Path

pInstanceId
required

identifier of the process instance that history should be collected for

integer (int64)

Query

activeOnly
optional

instructs if active nodes only should be collected, defaults to false

boolean

Query

completedOnly
optional

instructs if completed nodes only should be collected, defaults to false

boolean

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Responses
HTTP Code Description Schema

200

successful operation

404

Process Instance or Container Id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/processes/instances/0/nodes/instances
Example HTTP response
Response 200
{
  "node-instance" : [ {
    "node-instance-id" : 0,
    "node-name" : "string",
    "process-instance-id" : 0,
    "work-item-id" : 0,
    "container-id" : "string",
    "start-date" : "1970-01-01T00:00:00Z",
    "node-id" : "string",
    "node-type" : "string",
    "node-connection" : "string",
    "node-completed" : true,
    "reference-id" : 0,
    "sla-compliance" : 0,
    "sla-due-date" : "1970-01-01T00:00:00Z"
  } ]
}

Retrieves process instances that belong to given container and have given parent process instance, optionally allow to filter by process instance state.

GET /server/containers/{id}/processes/instances/{pInstanceId}/processes
Parameters
Type Name Description Schema Default

Path

id
required

container id that process instance belongs to

string

Path

pInstanceId
required

identifier of the parent process instance that process instances should be collected for

integer (int64)

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Query

sort
optional

optional sort column, no default

string

Query

sortOrder
optional

optional sort direction (asc, desc) - defaults to asc

boolean

"true"

Query

status
optional

optional process instance status (active, completed, aborted) - defaults ot active (1) only

< enum (1, 2, 3) > array(multi)

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/processes/instances/0/processes
Example HTTP response
Response 200
{
  "process-instance" : [ {
    "process-instance-id" : 0,
    "process-id" : "string",
    "process-name" : "string",
    "process-version" : "string",
    "process-instance-state" : 0,
    "container-id" : "string",
    "initiator" : "string",
    "start-date" : "1970-01-01T00:00:00Z",
    "process-instance-desc" : "string",
    "correlation-key" : "string",
    "parent-instance-id" : 0,
    "sla-compliance" : 0,
    "sla-due-date" : "1970-01-01T00:00:00Z",
    "active-user-tasks" : {
      "task-summary" : [ {
        "task-id" : 0,
        "task-name" : "string",
        "task-subject" : "string",
        "task-description" : "string",
        "task-status" : "string",
        "task-priority" : 0,
        "task-is-skipable" : true,
        "task-actual-owner" : "string",
        "task-created-by" : "string",
        "task-created-on" : "1970-01-01T00:00:00Z",
        "task-activation-time" : "1970-01-01T00:00:00Z",
        "task-expiration-time" : "1970-01-01T00:00:00Z",
        "task-proc-inst-id" : 0,
        "task-proc-def-id" : "string",
        "task-container-id" : "string",
        "task-parent-id" : 0
      } ]
    },
    "process-instance-variables" : {
      "string" : "object"
    }
  } ]
}

Signals active process instance identified by given id with singal name and optional event data

POST /server/containers/{id}/processes/instances/{pInstanceId}/signal/{sName}
Parameters
Type Name Description Schema

Path

id
required

container id that process instance belongs to

string

Path

pInstanceId
required

identifier of the process instance to be signaled

integer (int64)

Path

sName
required

signal name to be send to process instance

string

Body

body
optional

optional event data - any type can be provided

string

Responses
HTTP Code Description Schema

404

Process instance or Container Id not found

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/processes/instances/0/signal/string
Request body
{
    "Person": {
        "name": "john"
    }
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<person>
    <name>john</name>
</person>

Retrieves active process instance’s (identified by given id) active signals

GET /server/containers/{id}/processes/instances/{pInstanceId}/signals
Parameters
Type Name Description Schema

Path

id
required

container id that process instance belongs to

string

Path

pInstanceId
required

identifier of the process instance that signals should be collected for

integer (int64)

Responses
HTTP Code Description Schema

200

successful operation

< string > array

404

Process instance or Container Id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/processes/instances/0/signals
Example HTTP response
Response 200
[ "string" ]

Retrieves active process instance’s (identified by given id) variable given as variable name

GET /server/containers/{id}/processes/instances/{pInstanceId}/variable/{varName}
Parameters
Type Name Description Schema

Path

id
required

container id that process instance belongs to

string

Path

pInstanceId
required

identifier of the process instance that variable should be retrieved from

integer (int64)

Path

varName
required

variable name to be retrieved

string

Responses
HTTP Code Description Schema

200

successful operation

object

404

Process instance or Container Id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/processes/instances/0/variable/string
Example HTTP response
Response 200
{ }

Updates active process instance’s (identified by given id) variable with given name

PUT /server/containers/{id}/processes/instances/{pInstanceId}/variable/{varName}
Parameters
Type Name Description Schema

Path

id
required

container id that process instance belongs to

string

Path

pInstanceId
required

identifier of the process instance to be updated

integer (int64)

Path

varName
required

name of the variable to be set/updated

string

Body

body
required

variable data - any type can be provided

string

Responses
HTTP Code Description Schema

404

Process instance or Container Id not found

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/processes/instances/0/variable/string
Request body
{
    "Person": {
        "name": "john"
    }
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<person>
    <name>john</name>
</person>

Updates active process instance’s (identified by given id) variables given as map in the body

POST /server/containers/{id}/processes/instances/{pInstanceId}/variables
Parameters
Type Name Description Schema

Path

id
required

container id that process instance belongs to

string

Path

pInstanceId
required

identifier of the process instance to be updated

integer (int64)

Body

body
required

variable data give as map

string

Responses
HTTP Code Description Schema

404

Process instance or Container Id not found

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/processes/instances/0/variables
Request body
{
    "age": 25,
    "person": {
        "Person": {
            "name": "john"
        }
    }
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<map-type>
    <entries>
        <entry>
            <key>age</key>
            <value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema"
                    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">25</value>
        </entry>
        <entry>
            <key>person</key>
            <value xsi:type="person" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <name>john</name>
            </value>
        </entry>
    </entries>
</map-type>

Retrieves active process instance’s (identified by given id) variables, variables are returned as map where key is the variable name (string) and value is variable value (any type)

GET /server/containers/{id}/processes/instances/{pInstanceId}/variables
Parameters
Type Name Description Schema

Path

id
required

container id that process instance belongs to

string

Path

pInstanceId
required

identifier of the process instance that variables should be retrieved from

integer (int64)

Responses
HTTP Code Description Schema

200

successful operation

< string, object > map

404

Process instance or Container Id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/processes/instances/0/variables
Example HTTP response
Response 200
"object"

Retrieves variables last value (from audit logs) for given process instance

GET /server/containers/{id}/processes/instances/{pInstanceId}/variables/instances
Parameters
Type Name Description Schema

Path

id
required

container id that process instance belongs to

string

Path

pInstanceId
required

identifier of the process instance that variables state should be collected for

integer (int64)

Responses
HTTP Code Description Schema

200

successful operation

404

Process Instance or Container Id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/processes/instances/0/variables/instances
Example HTTP response
Response 200
{
  "variable-instance" : [ {
    "name" : "string",
    "old-value" : "string",
    "value" : "string",
    "process-instance-id" : 0,
    "modification-date" : "1970-01-01T00:00:00Z"
  } ]
}

Retrieves variable history (from audit logs) for given variable name that belongs to process instance

GET /server/containers/{id}/processes/instances/{pInstanceId}/variables/instances/{varName}
Parameters
Type Name Description Schema Default

Path

id
required

container id that process instance belongs to

string

Path

pInstanceId
required

identifier of the process instance that variable history should be collected for

integer (int64)

Path

varName
required

name of the variables that history should be collected for

string

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Responses
HTTP Code Description Schema

200

successful operation

404

Process Instance or Container Id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/processes/instances/0/variables/instances/string
Example HTTP response
Response 200
{
  "variable-instance" : [ {
    "name" : "string",
    "old-value" : "string",
    "value" : "string",
    "process-instance-id" : 0,
    "modification-date" : "1970-01-01T00:00:00Z"
  } ]
}

Retrieves work items within process instance and container

GET /server/containers/{id}/processes/instances/{pInstanceId}/workitems
Parameters
Type Name Description Schema

Path

id
required

container id that process instance belongs to

string

Path

pInstanceId
required

identifier of the process instance that work items belong to

integer (int64)

Responses
HTTP Code Description Schema

200

successful operation

404

Process instance, Work Item or Container Id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/processes/instances/0/workitems
Example HTTP response
Response 200
{
  "work-item-instance" : [ {
    "work-item-id" : 0,
    "work-item-name" : "string",
    "work-item-state" : 0,
    "work-item-params" : {
      "string" : "object"
    },
    "process-instance-id" : 0,
    "container-id" : "string",
    "node-instance-id" : 0,
    "node-id" : 0
  } ]
}

Retrieves work item identified by workItemId within process instance and container

GET /server/containers/{id}/processes/instances/{pInstanceId}/workitems/{workItemId}
Parameters
Type Name Description Schema

Path

id
required

container id that process instance belongs to

string

Path

pInstanceId
required

identifier of the process instance that work item belongs to

integer (int64)

Path

workItemId
required

identifier of the work item to retrieve

integer (int64)

Responses
HTTP Code Description Schema

200

successful operation

404

Process instance, Work Item or Container Id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/processes/instances/0/workitems/0
Example HTTP response
Response 200
{
  "work-item-id" : 0,
  "work-item-name" : "string",
  "work-item-state" : 0,
  "work-item-params" : {
    "string" : "object"
  },
  "process-instance-id" : 0,
  "container-id" : "string",
  "node-instance-id" : 0,
  "node-id" : 0
}

Aborts work item identified by workItemId within process instance and container

PUT /server/containers/{id}/processes/instances/{pInstanceId}/workitems/{workItemId}/aborted
Parameters
Type Name Description Schema

Path

id
required

container id that process instance belongs to

string

Path

pInstanceId
required

identifier of the process instance that work item belongs to

integer (int64)

Path

workItemId
required

identifier of the work item to abort

integer (int64)

Responses
HTTP Code Description Schema

404

Process instance, Work Item or Container Id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/processes/instances/0/workitems/0/aborted

Completes work item identified by workItemId within process instance and container. Optionally completion can provide outcome data - as map

PUT /server/containers/{id}/processes/instances/{pInstanceId}/workitems/{workItemId}/completed
Parameters
Type Name Description Schema

Path

id
required

container id that process instance belongs to

string

Path

pInstanceId
required

identifier of the process instance that work item belongs to

integer (int64)

Path

workItemId
required

identifier of the work item to complete

integer (int64)

Body

body
optional

optional outcome data give as map

string

Responses
HTTP Code Description Schema

404

Process instance, Work Item or Container Id not found

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/processes/instances/0/workitems/0/completed
Request body
{
    "age": 25,
    "person": {
        "Person": {
            "name": "john"
        }
    }
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<map-type>
    <entries>
        <entry>
            <key>age</key>
            <value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema"
                    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">25</value>
        </entry>
        <entry>
            <key>person</key>
            <value xsi:type="person" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <name>john</name>
            </value>
        </entry>
    </entries>
</map-type>

Starts new process instance of given process definition within given container with optional variables

POST /server/containers/{id}/processes/{pId}/instances
Parameters
Type Name Description Schema

Path

id
required

container id where the process definition resides

string

Path

pId
required

process id that new instance should be created from

string

Body

body
optional

optional map of process variables

string

Responses
HTTP Code Description Schema

201

Process instance started

integer (int64)

404

Process ID or Container Id not found

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/processes/string/instances
Request body
{
    "age": 25,
    "person": {
        "Person": {
            "name": "john"
        }
    }
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<map-type>
    <entries>
        <entry>
            <key>age</key>
            <value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema"
                    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">25</value>
        </entry>
        <entry>
            <key>person</key>
            <value xsi:type="person" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <name>john</name>
            </value>
        </entry>
    </entries>
</map-type>
Example HTTP response
Response 201
1
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<long-type>
    <value>1</value>
</long-type>

Starts new process instance with correlation key of given process definition within given container with optional variables

POST /server/containers/{id}/processes/{pId}/instances/correlation/{correlationKey}
Parameters
Type Name Description Schema

Path

correlationKey
required

correlation key to be assigned to process instance

string

Path

id
required

container id where the process definition resides

string

Path

pId
required

process id that new instance should be created from

string

Body

body
optional

optional map of process variables

string

Responses
HTTP Code Description Schema

201

successful operation

integer (int64)

404

Process ID or Container Id not found

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/processes/string/instances/correlation/string
Request body
{
    "age": 25,
    "person": {
        "Person": {
            "name": "john"
        }
    }
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<map-type>
    <entries>
        <entry>
            <key>age</key>
            <value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema"
                    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">25</value>
        </entry>
        <entry>
            <key>person</key>
            <value xsi:type="person" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <name>john</name>
            </value>
        </entry>
    </entries>
</map-type>
Example HTTP response
Response 201
0

Process Instances Administration :: BPM

Retrieves execution errors for container, applies pagination

GET /server/admin/containers/{id}/processes/errors
Parameters
Type Name Description Schema Default

Path

id
required

container id that errors belong to

string

Query

includeAck
optional

optional flag that indicates if acknowledged errors should also be collected, defaults to false

boolean

"false"

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Query

sort
optional

optional sort column, no default

string

Query

sortOrder
optional

optional sort direction (asc, desc) - defaults to asc

boolean

"true"

Responses
HTTP Code Description Schema

200

successful operation

404

Process instance or Container Id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/admin/containers/string/processes/errors
Example HTTP response
Response 200
{
  "node-instance" : [ {
    "node-instance-id" : 0,
    "node-name" : "string",
    "process-instance-id" : 0,
    "work-item-id" : 0,
    "container-id" : "string",
    "start-date" : "1970-01-01T00:00:00Z",
    "node-id" : "string",
    "node-type" : "string",
    "node-connection" : "string",
    "node-completed" : true,
    "reference-id" : 0,
    "sla-compliance" : 0,
    "sla-due-date" : "1970-01-01T00:00:00Z"
  } ]
}

Acknowledges given execution errors

PUT /server/admin/containers/{id}/processes/errors
Parameters
Type Name Description Schema

Path

id
required

container id that errors belong to

string

Query

errorId
required

list of error identifiers to be acknowledged

< string > array(multi)

Responses
HTTP Code Description Schema

404

Execution error or Container Id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/admin/containers/string/processes/errors?errorId=string

Retrieve execution error by its identifier

GET /server/admin/containers/{id}/processes/errors/{errorId}
Parameters
Type Name Description Schema

Path

errorId
required

identifier of error to be loaded

string

Path

id
required

container id that process error belongs to

string

Responses
HTTP Code Description Schema

200

successful operation

404

Process instance or Container Id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/admin/containers/string/processes/errors/string
Example HTTP response
Response 200
{
  "id" : "string",
  "type" : "string",
  "container-id" : "string",
  "process-instance-id" : 0,
  "process-id" : "string",
  "activity-id" : 0,
  "activity-name" : "string",
  "job-id" : 0,
  "error-msg" : "string",
  "error" : "string",
  "acknowledged" : true,
  "acknowledged-by" : "string",
  "acknowledged-at" : "1970-01-01T00:00:00Z",
  "error-date" : "1970-01-01T00:00:00Z"
}

Acknowledge execution error by given id

PUT /server/admin/containers/{id}/processes/errors/{errorId}
Parameters
Type Name Description Schema

Path

errorId
required

identifier of error to be acknowledged

string

Path

id
required

container id that error belongs to

string

Responses
HTTP Code Description Schema

404

Execution error or Container Id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/admin/containers/string/processes/errors/string

Migrates process instances to new container and process definition with optional node mapping

PUT /server/admin/containers/{id}/processes/instances
Parameters
Type Name Description Schema

Path

id
required

container id that process instances belongs to

string

Query

pInstanceId
required

list of identifiers of process instance to be migrated

< integer (int64) > array(multi)

Query

targetContainerId
required

container id that new process definition belongs to

string

Query

targetProcessId
required

process definition that process instances should be migrated to

string

Body

body
optional

node mapping - unique ids of old definition to new definition given as Map

string

Responses
HTTP Code Description Schema

201

successful operation

404

Process instance or Container Id not found

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/admin/containers/string/processes/instances?pInstanceId=0&targetContainerId=string&targetProcessId=string
Request body
{
    "age": 25,
    "name": "john"
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<map-type>
    <entries>
        <entry>
            <key>age</key>
            <value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema"
                    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">25</value>
        </entry>
        <entry>
            <key>name</key>
            <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema"
                    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">john</value>
        </entry>
    </entries>
</map-type>
Example HTTP response
Response 201
{
  "migration-report-instance" : [ {
    "migration-successful" : true,
    "migration-start" : "1970-01-01T00:00:00Z",
    "migration-end" : "1970-01-01T00:00:00Z",
    "migration-logs" : [ "string" ],
    "migration-process-instance" : 0
  } ]
}

Migrates process instance to new container and process definition with optional node mapping

PUT /server/admin/containers/{id}/processes/instances/{pInstanceId}
Parameters
Type Name Description Schema

Path

id
required

container id that process instance belongs to

string

Path

pInstanceId
required

identifier of process instance to be migrated

integer (int64)

Query

targetContainerId
required

container id that new process definition belongs to

string

Query

targetProcessId
required

process definition that process instance should be migrated to

string

Body

body
optional

node mapping - unique ids of old definition to new definition given as Map

string

Responses
HTTP Code Description Schema

201

successful operation

404

Process instance or Container Id not found

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/admin/containers/string/processes/instances/0?targetContainerId=string&targetProcessId=string
Request body
{
    "age": 25,
    "name": "john"
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<map-type>
    <entries>
        <entry>
            <key>age</key>
            <value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema"
                    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">25</value>
        </entry>
        <entry>
            <key>name</key>
            <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema"
                    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">john</value>
        </entry>
    </entries>
</map-type>
Example HTTP response
Response 201
{
  "migration-successful" : true,
  "migration-start" : "1970-01-01T00:00:00Z",
  "migration-end" : "1970-01-01T00:00:00Z",
  "migration-logs" : [ "string" ],
  "migration-process-instance" : 0
}

Retrieves execution errors for process instance and container, applies pagination

GET /server/admin/containers/{id}/processes/instances/{pInstanceId}/errors
Parameters
Type Name Description Schema Default

Path

id
required

container id that process instance belongs to

string

Path

pInstanceId
required

identifier of process instance that errors should be collected for

integer (int64)

Query

includeAck
optional

optional flag that indicates if acknowledged errors should also be collected, defaults to false

boolean

"false"

Query

node
optional

optional name of the node in the process instance to filter by

string

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Query

sort
optional

optional sort column, no default

string

Query

sortOrder
optional

optional sort direction (asc, desc) - defaults to asc

boolean

"true"

Responses
HTTP Code Description Schema

200

successful operation

404

Container Id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/admin/containers/string/processes/instances/0/errors
Example HTTP response
Response 200
{
  "error-instance" : [ {
    "id" : "string",
    "type" : "string",
    "container-id" : "string",
    "process-instance-id" : 0,
    "process-id" : "string",
    "activity-id" : 0,
    "activity-name" : "string",
    "job-id" : 0,
    "error-msg" : "string",
    "error" : "string",
    "acknowledged" : true,
    "acknowledged-by" : "string",
    "acknowledged-at" : "1970-01-01T00:00:00Z",
    "error-date" : "1970-01-01T00:00:00Z"
  } ]
}

Retrieves all active node instances from process instance and container

GET /server/admin/containers/{id}/processes/instances/{pInstanceId}/nodeinstances
Parameters
Type Name Description Schema

Path

id
required

container id that process instance belongs to

string

Path

pInstanceId
required

identifier of process instance that active nodes instances should be collected for

integer (int64)

Responses
HTTP Code Description Schema

200

successful operation

404

Process instance or Container Id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/admin/containers/string/processes/instances/0/nodeinstances
Example HTTP response
Response 200
{
  "node-instance" : [ {
    "node-instance-id" : 0,
    "node-name" : "string",
    "process-instance-id" : 0,
    "work-item-id" : 0,
    "container-id" : "string",
    "start-date" : "1970-01-01T00:00:00Z",
    "node-id" : "string",
    "node-type" : "string",
    "node-connection" : "string",
    "node-completed" : true,
    "reference-id" : 0,
    "sla-compliance" : 0,
    "sla-due-date" : "1970-01-01T00:00:00Z"
  } ]
}

Retriggers given node instance within process instance and container

PUT /server/admin/containers/{id}/processes/instances/{pInstanceId}/nodeinstances/{nodeInstanceId}
Parameters
Type Name Description Schema

Path

id
required

container id that process instance belongs to

string

Path

nodeInstanceId
required

identifier of node instance that should be retriggered

integer (int64)

Path

pInstanceId
required

identifier of process instance that node instance belongs to

integer (int64)

Responses
HTTP Code Description Schema

404

Process instance, node instance or Container Id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/admin/containers/string/processes/instances/0/nodeinstances/0

Cancels given node instance within process instance and container

DELETE /server/admin/containers/{id}/processes/instances/{pInstanceId}/nodeinstances/{nodeInstanceId}
Parameters
Type Name Description Schema

Path

id
required

container id that process instance belongs to

string

Path

nodeInstanceId
required

identifier of node instance that should be canceled

integer (int64)

Path

pInstanceId
required

identifier of process instance that node instance belongs to

integer (int64)

Responses
HTTP Code Description Schema

404

Process instance, node instance or Container Id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/admin/containers/string/processes/instances/0/nodeinstances/0

Retrieves all nodes from process instance and container

GET /server/admin/containers/{id}/processes/instances/{pInstanceId}/nodes
Parameters
Type Name Description Schema

Path

id
required

container id that process instance belongs to

string

Path

pInstanceId
required

identifier of process instance that process nodes should be collected from

integer (int64)

Responses
HTTP Code Description Schema

200

successful operation

404

Process instance or Container Id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/admin/containers/string/processes/instances/0/nodes
Example HTTP response
Response 200
{
  "process-node" : [ {
    "name" : "string",
    "id" : 0,
    "type" : "string",
    "process-id" : "string"
  } ]
}

Triggers node within process instance and container

POST /server/admin/containers/{id}/processes/instances/{pInstanceId}/nodes/{nodeId}
Parameters
Type Name Description Schema

Path

id
required

container id that process instance belongs to

string

Path

nodeId
required

identifier of the node to be triggered

integer (int64)

Path

pInstanceId
required

identifier of process instance where node should be triggered

integer (int64)

Responses
HTTP Code Description Schema

404

Process instance, node instance or Container Id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/admin/containers/string/processes/instances/0/nodes/0

Retrieves all active timer instance from process instance and container

GET /server/admin/containers/{id}/processes/instances/{pInstanceId}/timers
Parameters
Type Name Description Schema

Path

id
required

container id that process instance belongs to

string

Path

pInstanceId
required

identifier of process instance that timer instances should be collected for

integer (int64)

Responses
HTTP Code Description Schema

200

successful operation

404

Process instance or Container Id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/admin/containers/string/processes/instances/0/timers
Example HTTP response
Response 200
{
  "timer-instance" : [ {
    "name" : "string",
    "id" : 0,
    "activation-time" : "1970-01-01T00:00:00Z",
    "last-fire-time" : "1970-01-01T00:00:00Z",
    "next-fire-time" : "1970-01-01T00:00:00Z",
    "delay" : 0,
    "period" : 0,
    "repeat-limit" : 0,
    "process-instance-id" : 0,
    "session-id" : 0
  } ]
}

Updates timer instance within process instance and container

PUT /server/admin/containers/{id}/processes/instances/{pInstanceId}/timers/{timerId}
Parameters
Type Name Description Schema Default

Path

id
required

container id that process instance belongs to

string

Path

pInstanceId
required

identifier of process instance that timer belongs to

integer (int64)

Path

timerId
required

identifier of timer instance to be updated

integer (int64)

Query

relative
optional

optional flag that indicates if the time expression is relative to the current date or not, defaults to true

boolean

"true"

Body

body
required

Map of timer expressions - deplay, perios and repeat are allowed values in the map

string

Responses
HTTP Code Description Schema

404

Process instance, node instance or Container Id not found

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/admin/containers/string/processes/instances/0/timers/0
Request body
{
  "period" : 0,
  "delay" : 3,
  "repeatLimit" : 0
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<map-type>
    <entries>
        <entry>
            <key>period</key>
            <value xsi:type="xs:long" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">0</value>
        </entry>
        <entry>
            <key>delay</key>
            <value xsi:type="xs:long" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">3</value>
        </entry>
        <entry>
            <key>repeatLimit</key>
            <value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">0</value>
        </entry>
    </entries>
</map-type>

Queries - Case Definitions And Instances :: Case Management

Retrieves case definitions with filtering by name or id of the case definition and applies pagination

GET /server/queries/cases
Parameters
Type Name Description Schema Default

Query

filter
required

case definition id or name that case definitions will be filtered by

string

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Query

sort
optional

optional sort column, no default

string

Query

sortOrder
optional

optional sort direction (asc, desc) - defaults to asc

boolean

"true"

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/queries/cases?filter=string
Example HTTP response
Response 200
{
  "instances" : [ {
    "case-id" : "string",
    "case-description" : "string",
    "case-owner" : "string",
    "case-status" : 0,
    "case-definition-id" : "string",
    "container-id" : "string",
    "case-started-at" : "1970-01-01T00:00:00Z",
    "case-completed-at" : "1970-01-01T00:00:00Z",
    "case-completion-msg" : "string",
    "case-sla-compliance" : 0,
    "case-sla-due-date" : "1970-01-01T00:00:00Z",
    "case-file" : {
      "case-data" : {
        "string" : "object"
      },
      "case-user-assignments" : {
        "string" : "string"
      },
      "case-group-assignments" : {
        "string" : "string"
      },
      "case-data-restrictions" : {
        "string" : [ "string" ]
      }
    },
    "case-milestones" : [ {
      "milestone-name" : "string",
      "milestone-id" : "string",
      "milestone-achieved" : true,
      "milestone-achieved-at" : "1970-01-01T00:00:00Z",
      "milestone-status" : "string"
    } ],
    "case-stages" : [ {
      "stage-name" : "string",
      "stage-id" : "string",
      "stage-status" : "string",
      "adhoc-fragments" : [ {
        "name" : "string",
        "type" : "string"
      } ],
      "active-nodes" : [ {
        "node-instance-id" : 0,
        "node-name" : "string",
        "process-instance-id" : 0,
        "work-item-id" : 0,
        "container-id" : "string",
        "start-date" : "1970-01-01T00:00:00Z",
        "node-id" : "string",
        "node-type" : "string",
        "node-connection" : "string",
        "node-completed" : true,
        "reference-id" : 0,
        "sla-compliance" : 0,
        "sla-due-date" : "1970-01-01T00:00:00Z"
      } ]
    } ],
    "case-roles" : [ {
      "name" : "string",
      "users" : [ "string" ],
      "groups" : [ "string" ]
    } ]
  } ]
}

Retrieves case instances with authentication checks and applies pagination, allows to filter by data (case file) name and value, owner and case instance status

GET /server/queries/cases/instances
Parameters
Type Name Description Schema Default

Query

dataItemName
optional

data item name that case instances will be filtered by

string

Query

dataItemValue
optional

data item value that case instances will be filtered by

string

Query

owner
optional

case instance owner that case instances will be filtered by

string

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Query

sort
optional

optional sort column, no default

string

Query

sortOrder
optional

optional sort direction (asc, desc) - defaults to asc

boolean

"true"

Query

status
optional

optional case instance status (open, closed, canceled) - defaults ot open (1) only

< enum (open, closed, cancelled) > array(multi)

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/queries/cases/instances
Example HTTP response
Response 200
{
  "instances" : [ {
    "case-id" : "string",
    "case-description" : "string",
    "case-owner" : "string",
    "case-status" : 0,
    "case-definition-id" : "string",
    "container-id" : "string",
    "case-started-at" : "1970-01-01T00:00:00Z",
    "case-completed-at" : "1970-01-01T00:00:00Z",
    "case-completion-msg" : "string",
    "case-sla-compliance" : 0,
    "case-sla-due-date" : "1970-01-01T00:00:00Z",
    "case-file" : {
      "case-data" : {
        "string" : "object"
      },
      "case-user-assignments" : {
        "string" : "string"
      },
      "case-group-assignments" : {
        "string" : "string"
      },
      "case-data-restrictions" : {
        "string" : [ "string" ]
      }
    },
    "case-milestones" : [ {
      "milestone-name" : "string",
      "milestone-id" : "string",
      "milestone-achieved" : true,
      "milestone-achieved-at" : "1970-01-01T00:00:00Z",
      "milestone-status" : "string"
    } ],
    "case-stages" : [ {
      "stage-name" : "string",
      "stage-id" : "string",
      "stage-status" : "string",
      "adhoc-fragments" : [ {
        "name" : "string",
        "type" : "string"
      } ],
      "active-nodes" : [ {
        "node-instance-id" : 0,
        "node-name" : "string",
        "process-instance-id" : 0,
        "work-item-id" : 0,
        "container-id" : "string",
        "start-date" : "1970-01-01T00:00:00Z",
        "node-id" : "string",
        "node-type" : "string",
        "node-connection" : "string",
        "node-completed" : true,
        "reference-id" : 0,
        "sla-compliance" : 0,
        "sla-due-date" : "1970-01-01T00:00:00Z"
      } ]
    } ],
    "case-roles" : [ {
      "name" : "string",
      "users" : [ "string" ],
      "groups" : [ "string" ]
    } ]
  } ]
}

Retrieves case instance data items, allows to filter by name or type of data and applies pagination

GET /server/queries/cases/instances/{caseId}/caseFile
Parameters
Type Name Description Schema Default

Path

caseId
required

case instance identifier that data items should belong to

string

Query

name
optional

optionally filter by data item names

< string > array(multi)

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Query

type
optional

optionally filter by data item types

< string > array(multi)

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/queries/cases/instances/string/caseFile
Example HTTP response
Response 200
{
  "instances" : [ {
    "case-id" : "string",
    "case-description" : "string",
    "case-owner" : "string",
    "case-status" : 0,
    "case-definition-id" : "string",
    "container-id" : "string",
    "case-started-at" : "1970-01-01T00:00:00Z",
    "case-completed-at" : "1970-01-01T00:00:00Z",
    "case-completion-msg" : "string",
    "case-sla-compliance" : 0,
    "case-sla-due-date" : "1970-01-01T00:00:00Z",
    "case-file" : {
      "case-data" : {
        "string" : "object"
      },
      "case-user-assignments" : {
        "string" : "string"
      },
      "case-group-assignments" : {
        "string" : "string"
      },
      "case-data-restrictions" : {
        "string" : [ "string" ]
      }
    },
    "case-milestones" : [ {
      "milestone-name" : "string",
      "milestone-id" : "string",
      "milestone-achieved" : true,
      "milestone-achieved-at" : "1970-01-01T00:00:00Z",
      "milestone-status" : "string"
    } ],
    "case-stages" : [ {
      "stage-name" : "string",
      "stage-id" : "string",
      "stage-status" : "string",
      "adhoc-fragments" : [ {
        "name" : "string",
        "type" : "string"
      } ],
      "active-nodes" : [ {
        "node-instance-id" : 0,
        "node-name" : "string",
        "process-instance-id" : 0,
        "work-item-id" : 0,
        "container-id" : "string",
        "start-date" : "1970-01-01T00:00:00Z",
        "node-id" : "string",
        "node-type" : "string",
        "node-connection" : "string",
        "node-completed" : true,
        "reference-id" : 0,
        "sla-compliance" : 0,
        "sla-due-date" : "1970-01-01T00:00:00Z"
      } ]
    } ],
    "case-roles" : [ {
      "name" : "string",
      "users" : [ "string" ],
      "groups" : [ "string" ]
    } ]
  } ]
}

Retrieves case instance tasks assigned as business admin, allows to filter by task status and applies pagination

GET /server/queries/cases/instances/{caseId}/tasks/instances/admins
Parameters
Type Name Description Schema Default

Path

caseId
required

case instance identifier that tasks should belong to

string

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Query

sort
optional

optional sort column, no default

string

Query

sortOrder
optional

optional sort direction (asc, desc) - defaults to asc

boolean

"true"

Query

status
optional

optional task status (Created, Ready, Reserved, InProgress, Suspended, Completed, Failed, Error, Exited, Obsolete)

< enum (Created, Ready, Reserved, InProgress, Suspended, Completed, Failed, Error, Exited, Obsolete) > array(multi)

Query

user
optional

optional user id to be used instead of authenticated user - only when bypass authenticated user is enabled

string

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/queries/cases/instances/string/tasks/instances/admins
Example HTTP response
Response 200
{
  "instances" : [ {
    "case-id" : "string",
    "case-description" : "string",
    "case-owner" : "string",
    "case-status" : 0,
    "case-definition-id" : "string",
    "container-id" : "string",
    "case-started-at" : "1970-01-01T00:00:00Z",
    "case-completed-at" : "1970-01-01T00:00:00Z",
    "case-completion-msg" : "string",
    "case-sla-compliance" : 0,
    "case-sla-due-date" : "1970-01-01T00:00:00Z",
    "case-file" : {
      "case-data" : {
        "string" : "object"
      },
      "case-user-assignments" : {
        "string" : "string"
      },
      "case-group-assignments" : {
        "string" : "string"
      },
      "case-data-restrictions" : {
        "string" : [ "string" ]
      }
    },
    "case-milestones" : [ {
      "milestone-name" : "string",
      "milestone-id" : "string",
      "milestone-achieved" : true,
      "milestone-achieved-at" : "1970-01-01T00:00:00Z",
      "milestone-status" : "string"
    } ],
    "case-stages" : [ {
      "stage-name" : "string",
      "stage-id" : "string",
      "stage-status" : "string",
      "adhoc-fragments" : [ {
        "name" : "string",
        "type" : "string"
      } ],
      "active-nodes" : [ {
        "node-instance-id" : 0,
        "node-name" : "string",
        "process-instance-id" : 0,
        "work-item-id" : 0,
        "container-id" : "string",
        "start-date" : "1970-01-01T00:00:00Z",
        "node-id" : "string",
        "node-type" : "string",
        "node-connection" : "string",
        "node-completed" : true,
        "reference-id" : 0,
        "sla-compliance" : 0,
        "sla-due-date" : "1970-01-01T00:00:00Z"
      } ]
    } ],
    "case-roles" : [ {
      "name" : "string",
      "users" : [ "string" ],
      "groups" : [ "string" ]
    } ]
  } ]
}

Retrieves case instance tasks assigned as potential owner, allows to filter by task status and applies pagination

GET /server/queries/cases/instances/{caseId}/tasks/instances/pot-owners
Parameters
Type Name Description Schema Default

Path

caseId
required

case instance identifier that tasks should belong to

string

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Query

sort
optional

optional sort column, no default

string

Query

sortOrder
optional

optional sort direction (asc, desc) - defaults to asc

boolean

"true"

Query

status
optional

optional task status (Created, Ready, Reserved, InProgress, Suspended, Completed, Failed, Error, Exited, Obsolete)

< enum (Created, Ready, Reserved, InProgress, Suspended, Completed, Failed, Error, Exited, Obsolete) > array(multi)

Query

user
optional

optional user id to be used instead of authenticated user - only when bypass authenticated user is enabled

string

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/queries/cases/instances/string/tasks/instances/pot-owners
Example HTTP response
Response 200
{
  "instances" : [ {
    "case-id" : "string",
    "case-description" : "string",
    "case-owner" : "string",
    "case-status" : 0,
    "case-definition-id" : "string",
    "container-id" : "string",
    "case-started-at" : "1970-01-01T00:00:00Z",
    "case-completed-at" : "1970-01-01T00:00:00Z",
    "case-completion-msg" : "string",
    "case-sla-compliance" : 0,
    "case-sla-due-date" : "1970-01-01T00:00:00Z",
    "case-file" : {
      "case-data" : {
        "string" : "object"
      },
      "case-user-assignments" : {
        "string" : "string"
      },
      "case-group-assignments" : {
        "string" : "string"
      },
      "case-data-restrictions" : {
        "string" : [ "string" ]
      }
    },
    "case-milestones" : [ {
      "milestone-name" : "string",
      "milestone-id" : "string",
      "milestone-achieved" : true,
      "milestone-achieved-at" : "1970-01-01T00:00:00Z",
      "milestone-status" : "string"
    } ],
    "case-stages" : [ {
      "stage-name" : "string",
      "stage-id" : "string",
      "stage-status" : "string",
      "adhoc-fragments" : [ {
        "name" : "string",
        "type" : "string"
      } ],
      "active-nodes" : [ {
        "node-instance-id" : 0,
        "node-name" : "string",
        "process-instance-id" : 0,
        "work-item-id" : 0,
        "container-id" : "string",
        "start-date" : "1970-01-01T00:00:00Z",
        "node-id" : "string",
        "node-type" : "string",
        "node-connection" : "string",
        "node-completed" : true,
        "reference-id" : 0,
        "sla-compliance" : 0,
        "sla-due-date" : "1970-01-01T00:00:00Z"
      } ]
    } ],
    "case-roles" : [ {
      "name" : "string",
      "users" : [ "string" ],
      "groups" : [ "string" ]
    } ]
  } ]
}

Retrieves case instance tasks assigned as stakeholder, allows to filter by task status and applies pagination

GET /server/queries/cases/instances/{caseId}/tasks/instances/stakeholders
Parameters
Type Name Description Schema Default

Path

caseId
required

case instance identifier that tasks should belong to

string

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Query

sort
optional

optional sort column, no default

string

Query

sortOrder
optional

optional sort direction (asc, desc) - defaults to asc

boolean

"true"

Query

status
optional

optional task status (Created, Ready, Reserved, InProgress, Suspended, Completed, Failed, Error, Exited, Obsolete)

< enum (Created, Ready, Reserved, InProgress, Suspended, Completed, Failed, Error, Exited, Obsolete) > array(multi)

Query

user
optional

optional user id to be used instead of authenticated user - only when bypass authenticated user is enabled

string

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/queries/cases/instances/string/tasks/instances/stakeholders
Example HTTP response
Response 200
{
  "instances" : [ {
    "case-id" : "string",
    "case-description" : "string",
    "case-owner" : "string",
    "case-status" : 0,
    "case-definition-id" : "string",
    "container-id" : "string",
    "case-started-at" : "1970-01-01T00:00:00Z",
    "case-completed-at" : "1970-01-01T00:00:00Z",
    "case-completion-msg" : "string",
    "case-sla-compliance" : 0,
    "case-sla-due-date" : "1970-01-01T00:00:00Z",
    "case-file" : {
      "case-data" : {
        "string" : "object"
      },
      "case-user-assignments" : {
        "string" : "string"
      },
      "case-group-assignments" : {
        "string" : "string"
      },
      "case-data-restrictions" : {
        "string" : [ "string" ]
      }
    },
    "case-milestones" : [ {
      "milestone-name" : "string",
      "milestone-id" : "string",
      "milestone-achieved" : true,
      "milestone-achieved-at" : "1970-01-01T00:00:00Z",
      "milestone-status" : "string"
    } ],
    "case-stages" : [ {
      "stage-name" : "string",
      "stage-id" : "string",
      "stage-status" : "string",
      "adhoc-fragments" : [ {
        "name" : "string",
        "type" : "string"
      } ],
      "active-nodes" : [ {
        "node-instance-id" : 0,
        "node-name" : "string",
        "process-instance-id" : 0,
        "work-item-id" : 0,
        "container-id" : "string",
        "start-date" : "1970-01-01T00:00:00Z",
        "node-id" : "string",
        "node-type" : "string",
        "node-connection" : "string",
        "node-completed" : true,
        "reference-id" : 0,
        "sla-compliance" : 0,
        "sla-due-date" : "1970-01-01T00:00:00Z"
      } ]
    } ],
    "case-roles" : [ {
      "name" : "string",
      "users" : [ "string" ],
      "groups" : [ "string" ]
    } ]
  } ]
}

Retrieves process definitions with filtering by name or id of the process definition and applies pagination

GET /server/queries/cases/processes
Parameters
Type Name Description Schema Default

Query

filter
required

process definition id or name that process definitions will be filtered by

string

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Query

sort
optional

optional sort column, no default

string

Query

sortOrder
optional

optional sort direction (asc, desc) - defaults to asc

boolean

"true"

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/queries/cases/processes?filter=string
Example HTTP response
Response 200
{
  "instances" : [ {
    "case-id" : "string",
    "case-description" : "string",
    "case-owner" : "string",
    "case-status" : 0,
    "case-definition-id" : "string",
    "container-id" : "string",
    "case-started-at" : "1970-01-01T00:00:00Z",
    "case-completed-at" : "1970-01-01T00:00:00Z",
    "case-completion-msg" : "string",
    "case-sla-compliance" : 0,
    "case-sla-due-date" : "1970-01-01T00:00:00Z",
    "case-file" : {
      "case-data" : {
        "string" : "object"
      },
      "case-user-assignments" : {
        "string" : "string"
      },
      "case-group-assignments" : {
        "string" : "string"
      },
      "case-data-restrictions" : {
        "string" : [ "string" ]
      }
    },
    "case-milestones" : [ {
      "milestone-name" : "string",
      "milestone-id" : "string",
      "milestone-achieved" : true,
      "milestone-achieved-at" : "1970-01-01T00:00:00Z",
      "milestone-status" : "string"
    } ],
    "case-stages" : [ {
      "stage-name" : "string",
      "stage-id" : "string",
      "stage-status" : "string",
      "adhoc-fragments" : [ {
        "name" : "string",
        "type" : "string"
      } ],
      "active-nodes" : [ {
        "node-instance-id" : 0,
        "node-name" : "string",
        "process-instance-id" : 0,
        "work-item-id" : 0,
        "container-id" : "string",
        "start-date" : "1970-01-01T00:00:00Z",
        "node-id" : "string",
        "node-type" : "string",
        "node-connection" : "string",
        "node-completed" : true,
        "reference-id" : 0,
        "sla-compliance" : 0,
        "sla-due-date" : "1970-01-01T00:00:00Z"
      } ]
    } ],
    "case-roles" : [ {
      "name" : "string",
      "users" : [ "string" ],
      "groups" : [ "string" ]
    } ]
  } ]
}

Retrieves case instances where user is involved in given role and applies pagination, allows to filter by case instance status

GET /server/queries/cases/{caseRoleName}/instances
Parameters
Type Name Description Schema Default

Path

caseRoleName
required

case role that instances should be found for

string

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Query

sort
optional

optional sort column, no default

string

Query

sortOrder
optional

optional sort direction (asc, desc) - defaults to asc

boolean

"true"

Query

status
optional

optional case instance status (open, closed, canceled) - defaults ot open (1) only

< enum (open, closed, cancelled) > array(multi)

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/queries/cases/string/instances
Example HTTP response
Response 200
{
  "instances" : [ {
    "case-id" : "string",
    "case-description" : "string",
    "case-owner" : "string",
    "case-status" : 0,
    "case-definition-id" : "string",
    "container-id" : "string",
    "case-started-at" : "1970-01-01T00:00:00Z",
    "case-completed-at" : "1970-01-01T00:00:00Z",
    "case-completion-msg" : "string",
    "case-sla-compliance" : 0,
    "case-sla-due-date" : "1970-01-01T00:00:00Z",
    "case-file" : {
      "case-data" : {
        "string" : "object"
      },
      "case-user-assignments" : {
        "string" : "string"
      },
      "case-group-assignments" : {
        "string" : "string"
      },
      "case-data-restrictions" : {
        "string" : [ "string" ]
      }
    },
    "case-milestones" : [ {
      "milestone-name" : "string",
      "milestone-id" : "string",
      "milestone-achieved" : true,
      "milestone-achieved-at" : "1970-01-01T00:00:00Z",
      "milestone-status" : "string"
    } ],
    "case-stages" : [ {
      "stage-name" : "string",
      "stage-id" : "string",
      "stage-status" : "string",
      "adhoc-fragments" : [ {
        "name" : "string",
        "type" : "string"
      } ],
      "active-nodes" : [ {
        "node-instance-id" : 0,
        "node-name" : "string",
        "process-instance-id" : 0,
        "work-item-id" : 0,
        "container-id" : "string",
        "start-date" : "1970-01-01T00:00:00Z",
        "node-id" : "string",
        "node-type" : "string",
        "node-connection" : "string",
        "node-completed" : true,
        "reference-id" : 0,
        "sla-compliance" : 0,
        "sla-due-date" : "1970-01-01T00:00:00Z"
      } ]
    } ],
    "case-roles" : [ {
      "name" : "string",
      "users" : [ "string" ],
      "groups" : [ "string" ]
    } ]
  } ]
}

Retrieves process definitions that belong to given container and applies pagination

GET /server/queries/cases/{id}/processes
Parameters
Type Name Description Schema Default

Path

id
required

container id that process definitions should be filtered by

string

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Query

sort
optional

optional sort column, no default

string

Query

sortOrder
optional

optional sort direction (asc, desc) - defaults to asc

boolean

"true"

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/queries/cases/string/processes
Example HTTP response
Response 200
{
  "instances" : [ {
    "case-id" : "string",
    "case-description" : "string",
    "case-owner" : "string",
    "case-status" : 0,
    "case-definition-id" : "string",
    "container-id" : "string",
    "case-started-at" : "1970-01-01T00:00:00Z",
    "case-completed-at" : "1970-01-01T00:00:00Z",
    "case-completion-msg" : "string",
    "case-sla-compliance" : 0,
    "case-sla-due-date" : "1970-01-01T00:00:00Z",
    "case-file" : {
      "case-data" : {
        "string" : "object"
      },
      "case-user-assignments" : {
        "string" : "string"
      },
      "case-group-assignments" : {
        "string" : "string"
      },
      "case-data-restrictions" : {
        "string" : [ "string" ]
      }
    },
    "case-milestones" : [ {
      "milestone-name" : "string",
      "milestone-id" : "string",
      "milestone-achieved" : true,
      "milestone-achieved-at" : "1970-01-01T00:00:00Z",
      "milestone-status" : "string"
    } ],
    "case-stages" : [ {
      "stage-name" : "string",
      "stage-id" : "string",
      "stage-status" : "string",
      "adhoc-fragments" : [ {
        "name" : "string",
        "type" : "string"
      } ],
      "active-nodes" : [ {
        "node-instance-id" : 0,
        "node-name" : "string",
        "process-instance-id" : 0,
        "work-item-id" : 0,
        "container-id" : "string",
        "start-date" : "1970-01-01T00:00:00Z",
        "node-id" : "string",
        "node-type" : "string",
        "node-connection" : "string",
        "node-completed" : true,
        "reference-id" : 0,
        "sla-compliance" : 0,
        "sla-due-date" : "1970-01-01T00:00:00Z"
      } ]
    } ],
    "case-roles" : [ {
      "name" : "string",
      "users" : [ "string" ],
      "groups" : [ "string" ]
    } ]
  } ]
}

Queries - Processes, Nodes, Variables And Tasks :: BPM

Retrieves process instances filtered by container. Applies pagination by default and allows to specify sorting

GET /server/queries/containers/{id}/process/instances
Parameters
Type Name Description Schema Default

Path

id
required

container id to filter process instance

string

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Query

sort
optional

optional sort column, no default

string

Query

sortOrder
optional

optional sort direction (asc, desc) - defaults to asc

boolean

"true"

Query

status
optional

optional process instance status (active, completed, aborted) - defaults ot active (1) only

< enum (1, 2, 3) > array(multi)

Responses
HTTP Code Description Schema

200

successful operation

404

Container Id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/queries/containers/string/process/instances
Example HTTP response
Response 200
{
  "process-instance" : [ {
    "process-instance-id" : 0,
    "process-id" : "string",
    "process-name" : "string",
    "process-version" : "string",
    "process-instance-state" : 0,
    "container-id" : "string",
    "initiator" : "string",
    "start-date" : "1970-01-01T00:00:00Z",
    "process-instance-desc" : "string",
    "correlation-key" : "string",
    "parent-instance-id" : 0,
    "sla-compliance" : 0,
    "sla-due-date" : "1970-01-01T00:00:00Z",
    "active-user-tasks" : {
      "task-summary" : [ {
        "task-id" : 0,
        "task-name" : "string",
        "task-subject" : "string",
        "task-description" : "string",
        "task-status" : "string",
        "task-priority" : 0,
        "task-is-skipable" : true,
        "task-actual-owner" : "string",
        "task-created-by" : "string",
        "task-created-on" : "1970-01-01T00:00:00Z",
        "task-activation-time" : "1970-01-01T00:00:00Z",
        "task-expiration-time" : "1970-01-01T00:00:00Z",
        "task-proc-inst-id" : 0,
        "task-proc-def-id" : "string",
        "task-container-id" : "string",
        "task-parent-id" : 0
      } ]
    },
    "process-instance-variables" : {
      "string" : "object"
    }
  } ]
}

Retrieves process definitions that belong to given container

GET /server/queries/containers/{id}/processes/definitions
Parameters
Type Name Description Schema Default

Path

id
required

container id to filter process definitions

string

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Query

sort
optional

optional sort column, no default

string

Query

sortOrder
optional

optional sort direction (asc, desc) - defaults to asc

boolean

"true"

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/queries/containers/string/processes/definitions
Example HTTP response
Response 200
{
  "processes" : [ {
    "associatedEntities" : {
      "string" : [ "string" ]
    },
    "serviceTasks" : {
      "string" : "string"
    },
    "processVariables" : {
      "string" : "string"
    },
    "reusableSubProcesses" : [ "string" ],
    "process-id" : "string",
    "process-name" : "string",
    "process-version" : "string",
    "package" : "string",
    "container-id" : "string",
    "dynamic" : true
  } ]
}

Retrieves process definition that belong to given container and has matching process id

GET /server/queries/containers/{id}/processes/definitions/{pId}
Parameters
Type Name Description Schema

Path

id
required

container id that process definition belongs to

string

Path

pId
required

process id to load process definition

string

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/queries/containers/string/processes/definitions/string
Example HTTP response
Response 200
{
  "associatedEntities" : {
    "string" : [ "string" ]
  },
  "serviceTasks" : {
    "string" : "string"
  },
  "processVariables" : {
    "string" : "string"
  },
  "reusableSubProcesses" : [ "string" ],
  "process-id" : "string",
  "process-name" : "string",
  "process-version" : "string",
  "package" : "string",
  "container-id" : "string",
  "dynamic" : true
}

Retrieves process definitions filtered by process id or name

GET /server/queries/processes/definitions
Parameters
Type Name Description Schema Default

Query

filter
optional

process id or name to filter process definitions

string

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Query

sort
optional

optional sort column, no default

string

Query

sortOrder
optional

optional sort direction (asc, desc) - defaults to asc

boolean

"true"

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/queries/processes/definitions
Example HTTP response
Response 200
{
  "processes" : [ {
    "associatedEntities" : {
      "string" : [ "string" ]
    },
    "serviceTasks" : {
      "string" : "string"
    },
    "processVariables" : {
      "string" : "string"
    },
    "reusableSubProcesses" : [ "string" ],
    "process-id" : "string",
    "process-name" : "string",
    "process-version" : "string",
    "package" : "string",
    "container-id" : "string",
    "dynamic" : true
  } ]
}

Retrieves process definitions filtered by process id

GET /server/queries/processes/definitions/{pId}
Parameters
Type Name Description Schema

Path

pId
required

process id to load process definition

string

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/queries/processes/definitions/string
Example HTTP response
Response 200
{
  "processes" : [ {
    "associatedEntities" : {
      "string" : [ "string" ]
    },
    "serviceTasks" : {
      "string" : "string"
    },
    "processVariables" : {
      "string" : "string"
    },
    "reusableSubProcesses" : [ "string" ],
    "process-id" : "string",
    "process-name" : "string",
    "process-version" : "string",
    "package" : "string",
    "container-id" : "string",
    "dynamic" : true
  } ]
}

Retrieves process instance by exactly matched correlation key

GET /server/queries/processes/instance/correlation/{correlationKey}
Parameters
Type Name Description Schema

Path

correlationKey
required

correlation key associated with process instance

string

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/queries/processes/instance/correlation/string
Example HTTP response
Response 200
{
  "process-instance-id" : 0,
  "process-id" : "string",
  "process-name" : "string",
  "process-version" : "string",
  "process-instance-state" : 0,
  "container-id" : "string",
  "initiator" : "string",
  "start-date" : "1970-01-01T00:00:00Z",
  "process-instance-desc" : "string",
  "correlation-key" : "string",
  "parent-instance-id" : 0,
  "sla-compliance" : 0,
  "sla-due-date" : "1970-01-01T00:00:00Z",
  "active-user-tasks" : {
    "task-summary" : [ {
      "task-id" : 0,
      "task-name" : "string",
      "task-subject" : "string",
      "task-description" : "string",
      "task-status" : "string",
      "task-priority" : 0,
      "task-is-skipable" : true,
      "task-actual-owner" : "string",
      "task-created-by" : "string",
      "task-created-on" : "1970-01-01T00:00:00Z",
      "task-activation-time" : "1970-01-01T00:00:00Z",
      "task-expiration-time" : "1970-01-01T00:00:00Z",
      "task-proc-inst-id" : 0,
      "task-proc-def-id" : "string",
      "task-container-id" : "string",
      "task-parent-id" : 0
    } ]
  },
  "process-instance-variables" : {
    "string" : "object"
  }
}

Retrieves process instances filtered by status, initiator, processName - depending what query parameters are given. Applies pagination by default and allows to specify sorting

GET /server/queries/processes/instances
Parameters
Type Name Description Schema Default

Query

initiator
optional

optional process instance initiator - user who started process instance to filter process instances

string

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Query

processName
optional

optional process name to filter process instances

string

Query

sort
optional

optional sort column, no default

string

Query

sortOrder
optional

optional sort direction (asc, desc) - defaults to asc

boolean

"true"

Query

status
optional

optional process instance status (active, completed, aborted) - defaults ot active (1) only

< enum (1, 2, 3) > array(multi)

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/queries/processes/instances
Example HTTP response
Response 200
{
  "process-instance" : [ {
    "process-instance-id" : 0,
    "process-id" : "string",
    "process-name" : "string",
    "process-version" : "string",
    "process-instance-state" : 0,
    "container-id" : "string",
    "initiator" : "string",
    "start-date" : "1970-01-01T00:00:00Z",
    "process-instance-desc" : "string",
    "correlation-key" : "string",
    "parent-instance-id" : 0,
    "sla-compliance" : 0,
    "sla-due-date" : "1970-01-01T00:00:00Z",
    "active-user-tasks" : {
      "task-summary" : [ {
        "task-id" : 0,
        "task-name" : "string",
        "task-subject" : "string",
        "task-description" : "string",
        "task-status" : "string",
        "task-priority" : 0,
        "task-is-skipable" : true,
        "task-actual-owner" : "string",
        "task-created-by" : "string",
        "task-created-on" : "1970-01-01T00:00:00Z",
        "task-activation-time" : "1970-01-01T00:00:00Z",
        "task-expiration-time" : "1970-01-01T00:00:00Z",
        "task-proc-inst-id" : 0,
        "task-proc-def-id" : "string",
        "task-container-id" : "string",
        "task-parent-id" : 0
      } ]
    },
    "process-instance-variables" : {
      "string" : "object"
    }
  } ]
}

Retrieves process instances filtered by correlation key, retrieves all process instances that match correlationkey*. Applies pagination by default and allows to specify sorting

GET /server/queries/processes/instances/correlation/{correlationKey}
Parameters
Type Name Description Schema Default

Path

correlationKey
required

correlation key to filter process instance, can be given as partial correlation key like in starts with approach

string

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Query

sort
optional

optional sort column, no default

string

Query

sortOrder
optional

optional sort direction (asc, desc) - defaults to asc

boolean

"true"

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/queries/processes/instances/correlation/string
Example HTTP response
Response 200
{
  "process-instance" : [ {
    "process-instance-id" : 0,
    "process-id" : "string",
    "process-name" : "string",
    "process-version" : "string",
    "process-instance-state" : 0,
    "container-id" : "string",
    "initiator" : "string",
    "start-date" : "1970-01-01T00:00:00Z",
    "process-instance-desc" : "string",
    "correlation-key" : "string",
    "parent-instance-id" : 0,
    "sla-compliance" : 0,
    "sla-due-date" : "1970-01-01T00:00:00Z",
    "active-user-tasks" : {
      "task-summary" : [ {
        "task-id" : 0,
        "task-name" : "string",
        "task-subject" : "string",
        "task-description" : "string",
        "task-status" : "string",
        "task-priority" : 0,
        "task-is-skipable" : true,
        "task-actual-owner" : "string",
        "task-created-by" : "string",
        "task-created-on" : "1970-01-01T00:00:00Z",
        "task-activation-time" : "1970-01-01T00:00:00Z",
        "task-expiration-time" : "1970-01-01T00:00:00Z",
        "task-proc-inst-id" : 0,
        "task-proc-def-id" : "string",
        "task-container-id" : "string",
        "task-parent-id" : 0
      } ]
    },
    "process-instance-variables" : {
      "string" : "object"
    }
  } ]
}

Retrieves process instances filtered by by variable or by variable and its value. Applies pagination by default and allows to specify sorting

GET /server/queries/processes/instances/variables/{varName}
Parameters
Type Name Description Schema Default

Path

varName
required

variable name to filter process instance

string

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Query

sort
optional

optional sort column, no default

string

Query

sortOrder
optional

optional sort direction (asc, desc) - defaults to asc

boolean

"true"

Query

status
optional

optional process instance status (active, completed, aborted) - defaults ot active (1) only

< enum (1, 2, 3) > array(multi)

Query

varValue
optional

variable value to filter process instance, optional when filtering by name only required when filtering by name and value

string

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/queries/processes/instances/variables/string
Example HTTP response
Response 200
{
  "process-instance" : [ {
    "process-instance-id" : 0,
    "process-id" : "string",
    "process-name" : "string",
    "process-version" : "string",
    "process-instance-state" : 0,
    "container-id" : "string",
    "initiator" : "string",
    "start-date" : "1970-01-01T00:00:00Z",
    "process-instance-desc" : "string",
    "correlation-key" : "string",
    "parent-instance-id" : 0,
    "sla-compliance" : 0,
    "sla-due-date" : "1970-01-01T00:00:00Z",
    "active-user-tasks" : {
      "task-summary" : [ {
        "task-id" : 0,
        "task-name" : "string",
        "task-subject" : "string",
        "task-description" : "string",
        "task-status" : "string",
        "task-priority" : 0,
        "task-is-skipable" : true,
        "task-actual-owner" : "string",
        "task-created-by" : "string",
        "task-created-on" : "1970-01-01T00:00:00Z",
        "task-activation-time" : "1970-01-01T00:00:00Z",
        "task-expiration-time" : "1970-01-01T00:00:00Z",
        "task-proc-inst-id" : 0,
        "task-proc-def-id" : "string",
        "task-container-id" : "string",
        "task-parent-id" : 0
      } ]
    },
    "process-instance-variables" : {
      "string" : "object"
    }
  } ]
}

Retrieves process instance for given process instance id and optionally loads its variables

GET /server/queries/processes/instances/{pInstanceId}
Parameters
Type Name Description Schema

Path

pInstanceId
required

process instance id to retrieve process instance

integer (int64)

Query

withVars
optional

load process instance variables or not, defaults to false

boolean

Responses
HTTP Code Description Schema

200

successful operation

404

Process instance id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/queries/processes/instances/0
Example HTTP response
Response 200
{
  "process-instance-id" : 0,
  "process-id" : "string",
  "process-name" : "string",
  "process-version" : "string",
  "process-instance-state" : 0,
  "container-id" : "string",
  "initiator" : "string",
  "start-date" : "1970-01-01T00:00:00Z",
  "process-instance-desc" : "string",
  "correlation-key" : "string",
  "parent-instance-id" : 0,
  "sla-compliance" : 0,
  "sla-due-date" : "1970-01-01T00:00:00Z",
  "active-user-tasks" : {
    "task-summary" : [ {
      "task-id" : 0,
      "task-name" : "string",
      "task-subject" : "string",
      "task-description" : "string",
      "task-status" : "string",
      "task-priority" : 0,
      "task-is-skipable" : true,
      "task-actual-owner" : "string",
      "task-created-by" : "string",
      "task-created-on" : "1970-01-01T00:00:00Z",
      "task-activation-time" : "1970-01-01T00:00:00Z",
      "task-expiration-time" : "1970-01-01T00:00:00Z",
      "task-proc-inst-id" : 0,
      "task-proc-def-id" : "string",
      "task-container-id" : "string",
      "task-parent-id" : 0
    } ]
  },
  "process-instance-variables" : {
    "string" : "object"
  }
}

Retrieves node instances for given process instance. Depending on provided query parameters (activeOnly or completedOnly) will return active and/or completes nodes

GET /server/queries/processes/instances/{pInstanceId}/nodes/instances
Parameters
Type Name Description Schema Default

Path

pInstanceId
required

process instance id to to retrive history for

integer (int64)

Query

activeOnly
optional

include active nodes only

boolean

Query

completedOnly
optional

include completed nodes only

boolean

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/queries/processes/instances/0/nodes/instances
Example HTTP response
Response 200
{
  "node-instance" : [ {
    "node-instance-id" : 0,
    "node-name" : "string",
    "process-instance-id" : 0,
    "work-item-id" : 0,
    "container-id" : "string",
    "start-date" : "1970-01-01T00:00:00Z",
    "node-id" : "string",
    "node-type" : "string",
    "node-connection" : "string",
    "node-completed" : true,
    "reference-id" : 0,
    "sla-compliance" : 0,
    "sla-due-date" : "1970-01-01T00:00:00Z"
  } ]
}

Retrieves variables last value (from audit logs) for given process instance

GET /server/queries/processes/instances/{pInstanceId}/variables/instances
Parameters
Type Name Description Schema

Path

pInstanceId
required

process instance id to load variables current state (latest value) for

integer (int64)

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/queries/processes/instances/0/variables/instances
Example HTTP response
Response 200
{
  "variable-instance" : [ {
    "name" : "string",
    "old-value" : "string",
    "value" : "string",
    "process-instance-id" : 0,
    "modification-date" : "1970-01-01T00:00:00Z"
  } ]
}

Retrieves variable history (from audit logs) for given variable name that belongs to process instance

GET /server/queries/processes/instances/{pInstanceId}/variables/instances/{varName}
Parameters
Type Name Description Schema Default

Path

pInstanceId
required

process instance id to load variable history for

integer (int64)

Path

varName
required

variable name that history should be loaded for

string

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/queries/processes/instances/0/variables/instances/string
Example HTTP response
Response 200
{
  "variable-instance" : [ {
    "name" : "string",
    "old-value" : "string",
    "value" : "string",
    "process-instance-id" : 0,
    "modification-date" : "1970-01-01T00:00:00Z"
  } ]
}

Retrieves node instance for given process instance id and work item id

GET /server/queries/processes/instances/{pInstanceId}/wi-nodes/instances/{workItemId}
Parameters
Type Name Description Schema

Path

pInstanceId
required

process instance id that work item belongs to

integer (int64)

Path

workItemId
required

work item id to retrieve node instance for

integer (int64)

Responses
HTTP Code Description Schema

200

successful operation

404

Node instance id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/queries/processes/instances/0/wi-nodes/instances/0
Example HTTP response
Response 200
{
  "node-instance-id" : 0,
  "node-name" : "string",
  "process-instance-id" : 0,
  "work-item-id" : 0,
  "container-id" : "string",
  "start-date" : "1970-01-01T00:00:00Z",
  "node-id" : "string",
  "node-type" : "string",
  "node-connection" : "string",
  "node-completed" : true,
  "reference-id" : 0,
  "sla-compliance" : 0,
  "sla-due-date" : "1970-01-01T00:00:00Z"
}

Retrieves process instances filtered by process id. Applies pagination by default and allows to specify sorting

GET /server/queries/processes/{pId}/instances
Parameters
Type Name Description Schema Default

Path

pId
required

process id to filter process instance

string

Query

initiator
optional

optinal process instance initiator - user who started process instance to filtr process instances

string

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Query

sort
optional

optional sort column, no default

string

Query

sortOrder
optional

optional sort direction (asc, desc) - defaults to asc

boolean

"true"

Query

status
optional

optional process instance status (active, completed, aborted) - defaults ot active (1) only

< enum (1, 2, 3) > array(multi)

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/queries/processes/string/instances
Example HTTP response
Response 200
{
  "process-instance" : [ {
    "process-instance-id" : 0,
    "process-id" : "string",
    "process-name" : "string",
    "process-version" : "string",
    "process-instance-state" : 0,
    "container-id" : "string",
    "initiator" : "string",
    "start-date" : "1970-01-01T00:00:00Z",
    "process-instance-desc" : "string",
    "correlation-key" : "string",
    "parent-instance-id" : 0,
    "sla-compliance" : 0,
    "sla-due-date" : "1970-01-01T00:00:00Z",
    "active-user-tasks" : {
      "task-summary" : [ {
        "task-id" : 0,
        "task-name" : "string",
        "task-subject" : "string",
        "task-description" : "string",
        "task-status" : "string",
        "task-priority" : 0,
        "task-is-skipable" : true,
        "task-actual-owner" : "string",
        "task-created-by" : "string",
        "task-created-on" : "1970-01-01T00:00:00Z",
        "task-activation-time" : "1970-01-01T00:00:00Z",
        "task-expiration-time" : "1970-01-01T00:00:00Z",
        "task-proc-inst-id" : 0,
        "task-proc-def-id" : "string",
        "task-container-id" : "string",
        "task-parent-id" : 0
      } ]
    },
    "process-instance-variables" : {
      "string" : "object"
    }
  } ]
}

Retrieves tasks with applied pagination

GET /server/queries/tasks/instances
Parameters
Type Name Description Schema Default

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Query

sort
optional

optional sort column, no default

string

Query

sortOrder
optional

optional sort direction (asc, desc) - defaults to asc

boolean

"true"

Query

user
optional

optional user id to be used instead of authenticated user - only when bypass authenticated user is enabled

string

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/queries/tasks/instances
Example HTTP response
Response 200
{
  "task-summary" : [ {
    "task-id" : 0,
    "task-name" : "string",
    "task-subject" : "string",
    "task-description" : "string",
    "task-status" : "string",
    "task-priority" : 0,
    "task-is-skipable" : true,
    "task-actual-owner" : "string",
    "task-created-by" : "string",
    "task-created-on" : "1970-01-01T00:00:00Z",
    "task-activation-time" : "1970-01-01T00:00:00Z",
    "task-expiration-time" : "1970-01-01T00:00:00Z",
    "task-proc-inst-id" : 0,
    "task-proc-def-id" : "string",
    "task-container-id" : "string",
    "task-parent-id" : 0
  } ]
}

Retrieves tasks assigned as business administrator, optionally filters by status and applies pagination

GET /server/queries/tasks/instances/admins
Parameters
Type Name Description Schema Default

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Query

sort
optional

optional sort column, no default

string

Query

sortOrder
optional

optional sort direction (asc, desc) - defaults to asc

boolean

"true"

Query

status
optional

optional task status (Created, Ready, Reserved, InProgress, Suspended, Completed, Failed, Error, Exited, Obsolete)

< enum (Created, Ready, Reserved, InProgress, Suspended, Completed, Failed, Error, Exited, Obsolete) > array(multi)

Query

user
optional

optional user id to be used instead of authenticated user - only when bypass authenticated user is enabled

string

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/queries/tasks/instances/admins
Example HTTP response
Response 200
{
  "task-summary" : [ {
    "task-id" : 0,
    "task-name" : "string",
    "task-subject" : "string",
    "task-description" : "string",
    "task-status" : "string",
    "task-priority" : 0,
    "task-is-skipable" : true,
    "task-actual-owner" : "string",
    "task-created-by" : "string",
    "task-created-on" : "1970-01-01T00:00:00Z",
    "task-activation-time" : "1970-01-01T00:00:00Z",
    "task-expiration-time" : "1970-01-01T00:00:00Z",
    "task-proc-inst-id" : 0,
    "task-proc-def-id" : "string",
    "task-container-id" : "string",
    "task-parent-id" : 0
  } ]
}

Retrieves tasks owned, optionally filters by status and applies pagination

GET /server/queries/tasks/instances/owners
Parameters
Type Name Description Schema Default

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Query

sort
optional

optional sort column, no default

string

Query

sortOrder
optional

optional sort direction (asc, desc) - defaults to asc

boolean

"true"

Query

status
optional

optional task status (Created, Ready, Reserved, InProgress, Suspended, Completed, Failed, Error, Exited, Obsolete)

< enum (Created, Ready, Reserved, InProgress, Suspended, Completed, Failed, Error, Exited, Obsolete) > array(multi)

Query

user
optional

optional user id to be used instead of authenticated user - only when bypass authenticated user is enabled

string

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/queries/tasks/instances/owners
Example HTTP response
Response 200
{
  "task-summary" : [ {
    "task-id" : 0,
    "task-name" : "string",
    "task-subject" : "string",
    "task-description" : "string",
    "task-status" : "string",
    "task-priority" : 0,
    "task-is-skipable" : true,
    "task-actual-owner" : "string",
    "task-created-by" : "string",
    "task-created-on" : "1970-01-01T00:00:00Z",
    "task-activation-time" : "1970-01-01T00:00:00Z",
    "task-expiration-time" : "1970-01-01T00:00:00Z",
    "task-proc-inst-id" : 0,
    "task-proc-def-id" : "string",
    "task-container-id" : "string",
    "task-parent-id" : 0
  } ]
}

Retrieves tasks assigned as potential owner, optionally filters by status and given groups and applies pagination

GET /server/queries/tasks/instances/pot-owners
Parameters
Type Name Description Schema Default

Query

filter
optional

optional custom filter for task data

string

Query

groups
optional

optional group names to include in the query

< string > array(multi)

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Query

sort
optional

optional sort column, no default

string

Query

sortOrder
optional

optional sort direction (asc, desc) - defaults to asc

boolean

"true"

Query

status
optional

optional task status (Created, Ready, Reserved, InProgress, Suspended, Completed, Failed, Error, Exited, Obsolete)

< enum (Created, Ready, Reserved, InProgress, Suspended, Completed, Failed, Error, Exited, Obsolete) > array(multi)

Query

user
optional

optional user id to be used instead of authenticated user - only when bypass authenticated user is enabled

string

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/queries/tasks/instances/pot-owners
Example HTTP response
Response 200
{
  "task-summary" : [ {
    "task-id" : 0,
    "task-name" : "string",
    "task-subject" : "string",
    "task-description" : "string",
    "task-status" : "string",
    "task-priority" : 0,
    "task-is-skipable" : true,
    "task-actual-owner" : "string",
    "task-created-by" : "string",
    "task-created-on" : "1970-01-01T00:00:00Z",
    "task-activation-time" : "1970-01-01T00:00:00Z",
    "task-expiration-time" : "1970-01-01T00:00:00Z",
    "task-proc-inst-id" : 0,
    "task-proc-def-id" : "string",
    "task-container-id" : "string",
    "task-parent-id" : 0
  } ]
}

Retrieves tasks associated with given process instance, optionally filters by status and applies pagination

GET /server/queries/tasks/instances/process/{pInstanceId}
Parameters
Type Name Description Schema Default

Path

pInstanceId
required

process instance id to filter task instances

integer (int64)

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Query

sort
optional

optional sort column, no default

string

Query

sortOrder
optional

optional sort direction (asc, desc) - defaults to asc

boolean

"true"

Query

status
optional

optional task status (Created, Ready, Reserved, InProgress, Suspended, Completed, Failed, Error, Exited, Obsolete)

< enum (Created, Ready, Reserved, InProgress, Suspended, Completed, Failed, Error, Exited, Obsolete) > array(multi)

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/queries/tasks/instances/process/0
Example HTTP response
Response 200
{
  "task-summary" : [ {
    "task-id" : 0,
    "task-name" : "string",
    "task-subject" : "string",
    "task-description" : "string",
    "task-status" : "string",
    "task-priority" : 0,
    "task-is-skipable" : true,
    "task-actual-owner" : "string",
    "task-created-by" : "string",
    "task-created-on" : "1970-01-01T00:00:00Z",
    "task-activation-time" : "1970-01-01T00:00:00Z",
    "task-expiration-time" : "1970-01-01T00:00:00Z",
    "task-proc-inst-id" : 0,
    "task-proc-def-id" : "string",
    "task-container-id" : "string",
    "task-parent-id" : 0
  } ]
}

Retrieves tasks by variable name and optionally by variable value, optionally filters by status and applies pagination

GET /server/queries/tasks/instances/variables/{varName}
Parameters
Type Name Description Schema Default

Path

varName
required

name of the variable used to fiter tasks

string

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Query

sort
optional

optional sort column, no default

string

Query

sortOrder
optional

optional sort direction (asc, desc) - defaults to asc

boolean

"true"

Query

status
optional

optional task status (Created, Ready, Reserved, InProgress, Suspended, Completed, Failed, Error, Exited, Obsolete)

< enum (Created, Ready, Reserved, InProgress, Suspended, Completed, Failed, Error, Exited, Obsolete) > array(multi)

Query

user
optional

optional user id to be used instead of authenticated user - only when bypass authenticated user is enabled

string

Query

varValue
optional

value of the variable used to fiter tasks, optional when filtering only by name, required when filtering by both name and value

string

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/queries/tasks/instances/variables/string
Example HTTP response
Response 200
{
  "task-summary" : [ {
    "task-id" : 0,
    "task-name" : "string",
    "task-subject" : "string",
    "task-description" : "string",
    "task-status" : "string",
    "task-priority" : 0,
    "task-is-skipable" : true,
    "task-actual-owner" : "string",
    "task-created-by" : "string",
    "task-created-on" : "1970-01-01T00:00:00Z",
    "task-activation-time" : "1970-01-01T00:00:00Z",
    "task-expiration-time" : "1970-01-01T00:00:00Z",
    "task-proc-inst-id" : 0,
    "task-proc-def-id" : "string",
    "task-container-id" : "string",
    "task-parent-id" : 0
  } ]
}

Retrieves task by associated work item id

GET /server/queries/tasks/instances/workitem/{workItemId}
Parameters
Type Name Description Schema

Path

workItemId
required

work item id to load task associated with

integer (int64)

Responses
HTTP Code Description Schema

200

successful operation

404

Task not found for given work item id

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/queries/tasks/instances/workitem/0
Example HTTP response
Response 200
{
  "task-id" : 0,
  "task-priority" : 0,
  "task-name" : "string",
  "task-subject" : "string",
  "task-description" : "string",
  "task-type" : "string",
  "task-form" : "string",
  "task-status" : "string",
  "task-actual-owner" : "string",
  "task-created-by" : "string",
  "task-created-on" : "1970-01-01T00:00:00Z",
  "task-activation-time" : "1970-01-01T00:00:00Z",
  "task-expiration-time" : "1970-01-01T00:00:00Z",
  "task-skippable" : true,
  "task-workitem-id" : 0,
  "task-process-instance-id" : 0,
  "task-parent-id" : 0,
  "task-process-id" : "string",
  "task-container-id" : "string",
  "task-pot-owners" : [ "string" ],
  "task-excl-owners" : [ "string" ],
  "task-business-admins" : [ "string" ],
  "task-input-data" : {
    "string" : "object"
  },
  "task-output-data" : {
    "string" : "object"
  }
}

Retrieves task by task id

GET /server/queries/tasks/instances/{tInstanceId}
Parameters
Type Name Description Schema

Path

tInstanceId
required

task id to load task instance

integer (int64)

Responses
HTTP Code Description Schema

200

successful operation

404

Task not found for given id

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/queries/tasks/instances/0
Example HTTP response
Response 200
{
  "task-id" : 0,
  "task-priority" : 0,
  "task-name" : "string",
  "task-subject" : "string",
  "task-description" : "string",
  "task-type" : "string",
  "task-form" : "string",
  "task-status" : "string",
  "task-actual-owner" : "string",
  "task-created-by" : "string",
  "task-created-on" : "1970-01-01T00:00:00Z",
  "task-activation-time" : "1970-01-01T00:00:00Z",
  "task-expiration-time" : "1970-01-01T00:00:00Z",
  "task-skippable" : true,
  "task-workitem-id" : 0,
  "task-process-instance-id" : 0,
  "task-parent-id" : 0,
  "task-process-id" : "string",
  "task-container-id" : "string",
  "task-pot-owners" : [ "string" ],
  "task-excl-owners" : [ "string" ],
  "task-business-admins" : [ "string" ],
  "task-input-data" : {
    "string" : "object"
  },
  "task-output-data" : {
    "string" : "object"
  }
}

Retrieves task events for given task id and applies pagination

GET /server/queries/tasks/instances/{tInstanceId}/events
Parameters
Type Name Description Schema Default

Path

tInstanceId
required

task id to load task events for

integer (int64)

Query

page
optional

optional pagination - at which page to start, defaults to 0 (meaning first)

integer (int32)

0

Query

pageSize
optional

optional pagination - size of the result, defaults to 10

integer (int32)

10

Query

sort
optional

optional sort column, no default

string

Query

sortOrder
optional

optional sort direction (asc, desc) - defaults to asc

boolean

"true"

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/queries/tasks/instances/0/events
Example HTTP response
Response 200
{
  "task-event-instance" : [ {
    "task-event-id" : 0,
    "task-id" : 0,
    "task-event-type" : "string",
    "task-event-user" : "string",
    "task-event-date" : "1970-01-01T00:00:00Z",
    "task-process-instance-id" : 0,
    "task-work-item-id" : 0,
    "task-event-message" : "string"
  } ]
}

Rules Evaluation :: BRM

Evaluates rules by executing commands on the rule session

POST /server/containers/instances/{id}
Parameters
Type Name Description Schema

Path

id
required

Container id where rules should be evaluated on

string

Body

body
required

Commands to be executed on rule engine given as BatchExecutionCommand type

string

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/instances/string
Request body
Example HTTP response
Response 200
{
  "type" : "SUCCESS",
  "msg" : "string"
}

Static Files Endpoint :: BPM

Retrieves given resource/file based on the type and file name managed by given provider

GET /server/files/{provider}/{type}/{file}
Parameters
Type Name Description Schema

Path

file
required

Name of the resource to look up

string

Path

provider
required

Name of the provider that manages given resource

string

Path

type
required

Type of the resource e.g. js, css, etc

string

Responses
HTTP Code Description Schema

200

successful operation

string

404

resource/file not found

No Content

500

Unexpected error

No Content

Example HTTP request
Request path
/server/files/string/string/string
Example HTTP response
Response 200
"string"

Retrieves given resource/file based on the type and file name

GET /server/files/{type}/{file}
Parameters
Type Name Description Schema

Path

file
required

Name of the resource to look up

string

Path

type
required

Type of the resource e.g. js, css, etc

string

Responses
HTTP Code Description Schema

200

successful operation

string

404

resource/file not found

No Content

500

Unexpected error

No Content

Example HTTP request
Request path
/server/files/string/string
Example HTTP response
Response 200
"string"

User Task Operations And Queries :: BPM

Retrieves task with given id that belongs to given container, optionally loads its input, output data and assignments

GET /server/containers/{id}/tasks/{tInstanceId}
Parameters
Type Name Description Schema

Path

id
required

container id that task instance belongs to

string

Path

tInstanceId
required

identifier of the task instance that should be loaded

integer (int64)

Query

withAssignments
optional

optionally loads task people assignments

boolean

Query

withInputData
optional

optionally loads task input data

boolean

Query

withOutputData
optional

optionally loads task output data

boolean

Responses
HTTP Code Description Schema

200

successful operation

404

Task with given id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/tasks/0
Example HTTP response
Response 200
{
  "task-id" : 0,
  "task-priority" : 0,
  "task-name" : "string",
  "task-subject" : "string",
  "task-description" : "string",
  "task-type" : "string",
  "task-form" : "string",
  "task-status" : "string",
  "task-actual-owner" : "string",
  "task-created-by" : "string",
  "task-created-on" : "1970-01-01T00:00:00Z",
  "task-activation-time" : "1970-01-01T00:00:00Z",
  "task-expiration-time" : "1970-01-01T00:00:00Z",
  "task-skippable" : true,
  "task-workitem-id" : 0,
  "task-process-instance-id" : 0,
  "task-parent-id" : 0,
  "task-process-id" : "string",
  "task-container-id" : "string",
  "task-pot-owners" : [ "string" ],
  "task-excl-owners" : [ "string" ],
  "task-business-admins" : [ "string" ],
  "task-input-data" : {
    "string" : "object"
  },
  "task-output-data" : {
    "string" : "object"
  }
}

Updates task with given id that belongs to given container with given task instance details in body, updates name, description, priority, expiration date, form name, input and output variables

PUT /server/containers/{id}/tasks/{tInstanceId}
Parameters
Type Name Description Schema

Path

id
required

container id that task instance belongs to

string

Path

tInstanceId
required

identifier of the task instance that should be updated

integer (int64)

Query

user
optional

optional user id to be used instead of authenticated user - only when bypass authenticated user is enabled

string

Body

body
required

task instance with updates as TaskInstance type

string

Responses
HTTP Code Description Schema

404

Task with given id not found

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/tasks/0
Request body
{
  "task-id" : null,
  "task-priority" : 10,
  "task-name" : "Modified name",
  "task-subject" : null,
  "task-description" : "Simple user task.",
  "task-type" : null,
  "task-form" : null,
  "task-status" : null,
  "task-actual-owner" : null,
  "task-created-by" : null,
  "task-created-on" : null,
  "task-activation-time" : null,
  "task-expiration-time" : {
    "java.util.Date" : 1540025025627
  },
  "task-skippable" : null,
  "task-workitem-id" : null,
  "task-process-instance-id" : null,
  "task-parent-id" : null,
  "task-process-id" : null,
  "task-container-id" : null,
  "task-pot-owners" : null,
  "task-excl-owners" : null,
  "task-business-admins" : null,
  "task-input-data" : {
    "added input" : "test"
  },
  "task-output-data" : {
    "person_" : {
      "org.jbpm.data.Person" : {
        "name" : "mary"
      }
    },
    "string_" : "my custom data"
  }
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<task-instance>
    <task-priority>10</task-priority>
    <task-name>Modified name</task-name>
    <task-description>Simple user task.</task-description>
    <task-expiration-time>2018-10-20T10:43:45.273+02:00</task-expiration-time>
    <inputData>
        <entry>
            <key>added input</key>
            <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">test</value>
        </entry>
    </inputData>
    <outputData>
        <entry>
            <key>person_</key>
            <value xsi:type="person" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <name>mary</name>
            </value>
        </entry>
        <entry>
            <key>string_</key>
            <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">my custom data</value>
        </entry>
    </outputData>
</task-instance>

Adds attachment to task with given id that belongs to given container

POST /server/containers/{id}/tasks/{tInstanceId}/attachments
Parameters
Type Name Description Schema

Path

id
required

container id that task instance belongs to

string

Path

tInstanceId
required

identifier of the task instance that attachment should be added to

integer (int64)

Query

name
required

name of the attachment to be added

string

Query

user
optional

optional user id to be used instead of authenticated user - only when bypass authenticated user is enabled

string

Body

body
required

attachment content, any type can be provided

string

Responses
HTTP Code Description Schema

201

successful operation

integer (int64)

404

Task with given id not found

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/tasks/0/attachments?name=string
Request body
{
    "Person": {
        "name": "john"
    }
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<person>
    <name>john</name>
</person>
Example HTTP response
Response 201
0

Retrieves attachments from task with given id that belongs to given container

GET /server/containers/{id}/tasks/{tInstanceId}/attachments
Parameters
Type Name Description Schema

Path

id
required

container id that task instance belongs to

string

Path

tInstanceId
required

identifier of the task instance that attachments should be loaded for

integer (int64)

Responses
HTTP Code Description Schema

200

successful operation

404

Task with given id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/tasks/0/attachments
Example HTTP response
Response 200
{
  "task-attachment" : [ {
    "attachment-id" : 0,
    "attachment-name" : "string",
    "attachment-added-by" : "string",
    "attachment-added-at" : "1970-01-01T00:00:00Z",
    "attachment-type" : "string",
    "attachment-size" : 0,
    "attachment-content-id" : 0
  } ]
}

Retrieves attachment with given id from task with given id that belongs to given container

GET /server/containers/{id}/tasks/{tInstanceId}/attachments/{attachmentId}
Parameters
Type Name Description Schema

Path

attachmentId
required

identifier of the attachment to be loaded

integer (int64)

Path

id
required

container id that task instance belongs to

string

Path

tInstanceId
required

identifier of the task instance that attachment belongs to

integer (int64)

Responses
HTTP Code Description Schema

200

successful operation

404

Task with given id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/tasks/0/attachments/0
Example HTTP response
Response 200
{
  "attachment-id" : 0,
  "attachment-name" : "string",
  "attachment-added-by" : "string",
  "attachment-added-at" : "1970-01-01T00:00:00Z",
  "attachment-type" : "string",
  "attachment-size" : 0,
  "attachment-content-id" : 0
}

Deletes attachment from task with given id that belongs to given container

DELETE /server/containers/{id}/tasks/{tInstanceId}/attachments/{attachmentId}
Parameters
Type Name Description Schema

Path

attachmentId
required

identifier of the attachment to be deleted

integer (int64)

Path

id
required

container id that task instance belongs to

string

Path

tInstanceId
required

identifier of the task instance that attachment belongs to

integer (int64)

Responses
HTTP Code Description Schema

404

Task with given id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/tasks/0/attachments/0

Retrieves attachment’s content with given id from task with given id that belongs to given container

GET /server/containers/{id}/tasks/{tInstanceId}/attachments/{attachmentId}/content
Parameters
Type Name Description Schema

Path

attachmentId
required

identifier of the attachment that content should be loaded from

integer (int64)

Path

id
required

container id that task instance belongs to

string

Path

tInstanceId
required

identifier of the task instance that attachment belongs to

integer (int64)

Responses
HTTP Code Description Schema

200

successful operation

object

404

Task with given id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/tasks/0/attachments/0/content
Example HTTP response
Response 200
{ }

Adds comment to task with given id that belongs to given container

POST /server/containers/{id}/tasks/{tInstanceId}/comments
Parameters
Type Name Description Schema

Path

id
required

container id that task instance belongs to

string

Path

tInstanceId
required

identifier of the task instance that comment should be added to

integer (int64)

Body

body
required

comment data as TaskComment

string

Responses
HTTP Code Description Schema

201

successful operation

integer (int64)

404

Task with given id not found

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/server/containers/string/tasks/0/comments
Request body
{
  "comment-id" : null,
  "comment" : "First comment.",
  "comment-added-by" : "yoda",
  "comment-added-at" : {
    "java.util.Date" : 1539939094774
  }
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<task-comment>
    <comment>First comment.</comment>
    <comment-added-by>yoda</comment-added-by>
    <comment-added-at>2018-10-19T10:51:34.405+02:00</comment-added-at>
</task-comment>
Example HTTP response
Response 201
0

Retrieves comments from task with given id that belongs to given container

GET /server/containers/{id}/tasks/{tInstanceId}/comments
Parameters
Type Name Description Schema

Path

id
required

container id that task instance belongs to

string

Path

tInstanceId
required

identifier of the task instance that comments should be loaded for

integer (int64)

Responses
HTTP Code Description Schema

200

successful operation

404

Task with given id not found

No Content

500

Unexpected error

No Content

Produces
  • application/xml