GET /server/admin/cases/instances
REST API
Resources
Case Instance Administration
Returns case instances without authentication checks.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Query |
sort |
optional sort column, no default |
string |
|
Query |
sortOrder |
optional sort direction (asc, desc) - defaults to asc |
boolean |
|
Query |
status |
optional case instance status (open, closed, canceled) - defaults ot open (1) only |
< enum (open, closed, cancelled) > array(multi) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/admin/cases/instances
Example HTTP response
Response 200
{
"instances": [
{
"case-id": "IT-0000000006",
"case-description": "Order for IT hardware",
"case-owner": "baAdmin",
"case-status": 1,
"case-definition-id": "itorders.orderhardware",
"container-id": "itorders_1.0.0-SNAPSHOT",
"case-started-at": 1540474204152,
"case-completed-at": null,
"case-completion-msg": "",
"case-sla-compliance": 0,
"case-sla-due-date": null,
"case-file": null,
"case-milestones": null,
"case-stages": null,
"case-roles": null
},
{
"case-id": "IT-0000000011",
"case-description": "Order for IT hardware",
"case-owner": "baAdmin",
"case-status": 1,
"case-definition-id": "itorders.orderhardware",
"container-id": "itorders_1.0.0-SNAPSHOT6",
"case-started-at": 1540496734746,
"case-completed-at": null,
"case-completion-msg": "",
"case-sla-compliance": 0,
"case-sla-due-date": null,
"case-file": null,
"case-milestones": null,
"case-stages": null,
"case-roles": null
}
]
}Migrates a specified case instance to another KIE container and case definition.
PUT /server/admin/containers/{containerId}/cases/instances/{caseId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
caseId |
identifier of case instance to be migrated |
string |
Path |
containerId |
container id that case instance belongs to |
string |
Query |
targetContainerId |
container id that new case definition should be migrated to to |
string |
Body |
body |
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 |
Successfull response |
No Content |
404 |
Case instance or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Consumes
-
application/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/admin/containers/evaluation_1.0.0-SNAPSHOT/cases/instances/CASE-000000001?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": "IT-0000000006",
"case-migration-successful": true,
"case-migration-start": {
"java.util.Date": 1540526940760
},
"case-migration-end": {
"java.util.Date": 1540526940867
},
"case-migration-reports": [
{
"migration-successful": true,
"migration-start": {
"java.util.Date": 1540526940760
},
"migration-end": {
"java.util.Date": 1540526940863
},
"migration-logs": [
"INFO Fri Oct 26 00:09:00 EDT 2018 Variable instances updated = 2 for process instance id 27",
"INFO Fri Oct 26 00:09:00 EDT 2018 Node instances updated = 4 for process instance id 27",
"INFO Fri Oct 26 00:09:00 EDT 2018 Process instances updated = 1 for process instance id 27",
"INFO Fri Oct 26 00:09:00 EDT 2018 Task variables updated = 6 for process instance id 27",
"INFO Fri Oct 26 00:09:00 EDT 2018 Task audit updated = 1 for process instance id 27",
"INFO Fri Oct 26 00:09:00 EDT 2018 Tasks updated = 1 for process instance id 27",
"INFO Fri Oct 26 00:09:00 EDT 2018 Context info updated = 1 for process instance id 27",
"INFO Fri Oct 26 00:09:00 EDT 2018 Mapping: Node instance logs to be updated = [0]",
"INFO Fri Oct 26 00:09:00 EDT 2018 Mapping: Node instance logs updated = 1 for node instance id 0",
"INFO Fri Oct 26 00:09:00 EDT 2018 Mapping: Task audit updated = 1 for task id 33",
"INFO Fri Oct 26 00:09:00 EDT 2018 Mapping: Task updated = 1 for task id 33",
"INFO Fri Oct 26 00:09:00 EDT 2018 Mapping: Node instance logs to be updated = [1]",
"INFO Fri Oct 26 00:09:00 EDT 2018 Mapping: Node instance logs updated = 1 for node instance id 1",
"INFO Fri Oct 26 00:09:00 EDT 2018 Mapping: Node instance logs to be updated = [2]",
"INFO Fri Oct 26 00:09:00 EDT 2018 Mapping: Node instance logs updated = 1 for node instance id 2",
"INFO Fri Oct 26 00:09:00 EDT 2018 Mapping: Node instance logs to be updated = [3]",
"INFO Fri Oct 26 00:09:00 EDT 2018 Mapping: Node instance logs updated = 1 for node instance id 3",
"INFO Fri Oct 26 00:09:00 EDT 2018 Migration of process instance (27) completed successfully to process itorders.orderhardware2"
],
"migration-process-instance": 27
}
]
}Case Instances
Returns case definitions in a specified KIE container.
GET /server/containers/{containerId}/cases/definitions
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
containerId |
container id that should be used to filter case definitions |
string |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Query |
sort |
optional sort column, no default |
string |
|
Query |
sortOrder |
optional sort direction (asc, desc) - defaults to asc |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/cases/definitions
Example HTTP response
Response 200
{
"definitions": [
{
"name": "Order for IT hardware",
"id": "itorders.orderhardware",
"version": "1.0",
"case-id-prefix": "IT",
"container-id": "itorders_1.0.0-SNAPSHOT2",
"adhoc-fragments": [
{
"name": "Prepare hardware spec",
"type": "HumanTaskNode"
},
{
"name": "Milestone 1: Order placed",
"type": "MilestoneNode"
},
{
"name": "Milestone 2: Order shipped",
"type": "MilestoneNode"
},
{
"name": "Milestone 3: Delivered to customer",
"type": "MilestoneNode"
},
{
"name": "Hardware spec ready",
"type": "MilestoneNode"
},
{
"name": "Manager decision",
"type": "MilestoneNode"
}
],
"roles": {
"owner": 1,
"manager": 1,
"supplier": 2
},
"milestones": [
{
"milestone-name": "Milestone 1: Order placed",
"milestone-id": "_DCD97847-6E3C-4C5E-9EE3-221C04BE42ED",
"milestone-mandatory": false
},
{
"milestone-name": "Milestone 2: Order shipped",
"milestone-id": "_343B90CD-AA19-4894-B63C-3CE1906E6FD1",
"milestone-mandatory": false
},
{
"milestone-name": "Milestone 3: Delivered to customer",
"milestone-id": "_52AFA23F-C087-4519-B8F2-BABCC31D68A6",
"milestone-mandatory": false
},
{
"milestone-name": "Hardware spec ready",
"milestone-id": "_483CF785-96DD-40C1-9148-4CFAFAE5778A",
"milestone-mandatory": false
},
{
"milestone-name": "Manager decision",
"milestone-id": "_79953D58-25DB-4FD6-94A0-DFC6EA2D0339",
"milestone-mandatory": false
}
],
"stages": []
},
{
"name": "Order for IT hardware",
"id": "itorders.orderhardware",
"version": "1.0",
"case-id-prefix": "IT",
"container-id": "itorders_1.0.0-SNAPSHOT3",
"adhoc-fragments": [
{
"name": "Prepare hardware spec",
"type": "HumanTaskNode"
},
{
"name": "Milestone 1: Order placed",
"type": "MilestoneNode"
},
{
"name": "Milestone 2: Order shipped",
"type": "MilestoneNode"
},
{
"name": "Milestone 3: Delivered to customer",
"type": "MilestoneNode"
},
{
"name": "Hardware spec ready",
"type": "MilestoneNode"
},
{
"name": "Manager decision",
"type": "MilestoneNode"
}
],
"roles": {
"owner": 1,
"manager": 1,
"supplier": 2
},
"milestones": [
{
"milestone-name": "Milestone 1: Order placed",
"milestone-id": "_DCD97847-6E3C-4C5E-9EE3-221C04BE42ED",
"milestone-mandatory": false
},
{
"milestone-name": "Milestone 2: Order shipped",
"milestone-id": "_343B90CD-AA19-4894-B63C-3CE1906E6FD1",
"milestone-mandatory": false
},
{
"milestone-name": "Milestone 3: Delivered to customer",
"milestone-id": "_52AFA23F-C087-4519-B8F2-BABCC31D68A6",
"milestone-mandatory": false
},
{
"milestone-name": "Hardware spec ready",
"milestone-id": "_483CF785-96DD-40C1-9148-4CFAFAE5778A",
"milestone-mandatory": false
},
{
"milestone-name": "Manager decision",
"milestone-id": "_79953D58-25DB-4FD6-94A0-DFC6EA2D0339",
"milestone-mandatory": false
}
],
"stages": []
}
]
}Returns information about a specified case definition.
GET /server/containers/{containerId}/cases/definitions/{caseDefId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
caseDefId |
case definition id that should be loaded |
string |
Path |
containerId |
container id that should be used to filter case definitions |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/cases/definitions/CASE-00000000001
Example HTTP response
Response 200
{
"name": "Order for IT hardware",
"id": "itorders.orderhardware",
"version": "1.0",
"case-id-prefix": "IT",
"container-id": "itorders_1.0.0-SNAPSHOT",
"adhoc-fragments": [
{
"name": "Prepare hardware spec",
"type": "HumanTaskNode"
},
{
"name": "Milestone 1: Order placed",
"type": "MilestoneNode"
},
{
"name": "Milestone 2: Order shipped",
"type": "MilestoneNode"
},
{
"name": "Milestone 3: Delivered to customer",
"type": "MilestoneNode"
},
{
"name": "Hardware spec ready",
"type": "MilestoneNode"
},
{
"name": "Manager decision",
"type": "MilestoneNode"
}
],
"roles": {
"owner": 1,
"manager": 1,
"supplier": 2
},
"milestones": [
{
"milestone-name": "Milestone 1: Order placed",
"milestone-id": "_DCD97847-6E3C-4C5E-9EE3-221C04BE42ED",
"milestone-mandatory": false
},
{
"milestone-name": "Milestone 2: Order shipped",
"milestone-id": "_343B90CD-AA19-4894-B63C-3CE1906E6FD1",
"milestone-mandatory": false
},
{
"milestone-name": "Milestone 3: Delivered to customer",
"milestone-id": "_52AFA23F-C087-4519-B8F2-BABCC31D68A6",
"milestone-mandatory": false
},
{
"milestone-name": "Hardware spec ready",
"milestone-id": "_483CF785-96DD-40C1-9148-4CFAFAE5778A",
"milestone-mandatory": false
},
{
"milestone-name": "Manager decision",
"milestone-id": "_79953D58-25DB-4FD6-94A0-DFC6EA2D0339",
"milestone-mandatory": false
}
],
"stages": []
}Returns case instances in a specified KIE container.
GET /server/containers/{containerId}/cases/instances
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
containerId |
container id that should be used to filter case instances |
string |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Query |
sort |
optional sort column, no default |
string |
|
Query |
sortOrder |
optional sort direction (asc, desc) - defaults to asc |
boolean |
|
Query |
status |
optional case instance status (open, closed, canceled) - defaults ot open (1) only |
< enum (open, closed, cancelled) > array(multi) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/cases/instances
Example HTTP response
Response 200
{
"instances": [
{
"case-id": "IT-0000000006",
"case-description": "Order for IT hardware",
"case-owner": "baAdmin",
"case-status": 1,
"case-definition-id": "itorders.orderhardware",
"container-id": "itorders_1.0.0-SNAPSHOT",
"case-started-at": 1540474204152,
"case-completed-at": null,
"case-completion-msg": "",
"case-sla-compliance": 0,
"case-sla-due-date": null,
"case-file": null,
"case-milestones": null,
"case-stages": null,
"case-roles": null
},
{
"case-id": "IT-0000000011",
"case-description": "Order for IT hardware",
"case-owner": "baAdmin",
"case-status": 1,
"case-definition-id": "itorders.orderhardware",
"container-id": "itorders_1.0.0-SNAPSHOT6",
"case-started-at": 1540496734746,
"case-completed-at": null,
"case-completion-msg": "",
"case-sla-compliance": 0,
"case-sla-due-date": null,
"case-file": null,
"case-milestones": null,
"case-stages": null,
"case-roles": null
}
]
}Closes a specified case instance.
POST /server/containers/{containerId}/cases/instances/{caseId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
caseId |
identifier of the case instance |
string |
Path |
containerId |
container id that case instance belongs to |
string |
Body |
body |
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/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/cases/instances/CASE-00000000001
Request body
Returns information about a specified case instance.
GET /server/containers/{containerId}/cases/instances/{caseId}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
caseId |
identifier of the case instance |
string |
|
Path |
containerId |
container id that case instance belongs to |
string |
|
Query |
withData |
optional flag to load data when loading case instance |
boolean |
|
Query |
withMilestones |
optional flag to load milestones when loading case instance |
boolean |
|
Query |
withRoles |
optional flag to load roles when loading case instance |
boolean |
|
Query |
withStages |
optional flag to load stages when loading case instance |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Case instance not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/cases/instances/CASE-00000000001
Example HTTP response
Response 200
{
"case-id": "IT-0000000006",
"case-description": "Order for IT hardware",
"case-owner": "baAdmin",
"case-status": 1,
"case-definition-id": "itorders.orderhardware",
"container-id": "itorders_1.0.0-SNAPSHOT",
"case-started-at": 1540474204152,
"case-completed-at": null,
"case-completion-msg": "",
"case-sla-compliance": 0,
"case-sla-due-date": null,
"case-file": {
"case-data": {},
"case-user-assignments": {},
"case-group-assignments": {},
"case-data-restrictions": {}
},
"case-milestones": null,
"case-stages": null,
"case-roles": [
{
"name": "owner",
"users": [
"baAdmin"
],
"groups": []
},
{
"name": "manager",
"users": [
"baAdmin"
],
"groups": []
},
{
"name": "supplier",
"users": [],
"groups": [
"IT"
]
}
]
}Aborts or permanently destroys a specified case instance.
DELETE /server/containers/{containerId}/cases/instances/{caseId}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
caseId |
identifier of the case instance |
string |
|
Path |
containerId |
container id that case instance belongs to |
string |
|
Query |
destroy |
allows to destroy (permanently) case instance as part of the cancel operation, defaults to false |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
404 |
Case instance not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/cases/instances/CASE-00000000001
Returns ad hoc fragments for a specified case instance.
GET /server/containers/{containerId}/cases/instances/{caseId}/adhocfragments
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
caseId |
identifier of the case instance |
string |
Path |
containerId |
container id that case instance belongs to |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Case instance not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/cases/instances/CASE-00000000001/adhocfragments
Example HTTP response
Response 200
{
"fragments": [
{
"name": "Prepare hardware spec",
"type": "HumanTaskNode"
},
{
"name": "Milestone 1: Order placed",
"type": "MilestoneNode"
},
{
"name": "Milestone 2: Order shipped",
"type": "MilestoneNode"
},
{
"name": "Milestone 3: Delivered to customer",
"type": "MilestoneNode"
},
{
"name": "Hardware spec ready",
"type": "MilestoneNode"
},
{
"name": "Manager decision",
"type": "MilestoneNode"
}
]
}Adds data as case files in a specified case instance.
POST /server/containers/{containerId}/cases/instances/{caseId}/caseFile
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
caseId |
identifier of the case instance |
string |
Path |
containerId |
container id that case instance belongs to |
string |
Query |
restrictedTo |
optional role name(s) that given data should be restricted to |
< string > array(multi) |
Body |
body |
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/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/cases/instances/CASE-00000000001/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>Returns data from the case files of a specified case instance.
GET /server/containers/{containerId}/cases/instances/{caseId}/caseFile
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
caseId |
identifier of the case instance |
string |
Path |
containerId |
container id that case instance belongs to |
string |
Query |
name |
optional name(s) of the data items to retrieve |
< string > array(multi) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Case instance not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/cases/instances/CASE-00000000001/caseFile
Example HTTP response
Response 200
{
"age": 25,
"person": {
"Person": {
"name": "john"
}
}
}Deletes one or more specified case file data items from a specified case instance.
DELETE /server/containers/{containerId}/cases/instances/{caseId}/caseFile
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
caseId |
identifier of the case instance |
string |
Path |
containerId |
container id that case instance belongs to |
string |
Query |
dataId |
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/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/cases/instances/CASE-00000000001/caseFile?dataId=string
Adds a single data item as a case file in a specified case instance.
POST /server/containers/{containerId}/cases/instances/{caseId}/caseFile/{dataId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
caseId |
identifier of the case instance |
string |
Path |
containerId |
container id that case instance belongs to |
string |
Path |
dataId |
name of the data item to be added to case file |
string |
Query |
restrictedTo |
optional role name(s) that given data should be restricted to |
< string > array(multi) |
Body |
body |
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/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/cases/instances/CASE-00000000001/caseFile/string
Request body
{
"Person": {
"name": "john"
}
}<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<person>
<name>john</name>
</person>Returns the value of a specified case file data item in a specified case instance.
GET /server/containers/{containerId}/cases/instances/{caseId}/caseFile/{dataId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
caseId |
identifier of the case instance |
string |
Path |
containerId |
container id that case instance belongs to |
string |
Path |
dataId |
name of the data item within case file to retrieve |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Case instance not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/cases/instances/CASE-00000000001/caseFile/string
Example HTTP response
Response 200
{
"Person": {
"name": "john"
}
}Adds a comment to a specified case instance.
POST /server/containers/{containerId}/cases/instances/{caseId}/comments
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
caseId |
identifier of the case instance |
string |
Path |
containerId |
container id that case instance belongs to |
string |
Query |
author |
optional user id to be used instead of authenticated user - only when bypass authenticated user is enabled |
string |
Query |
restrictedTo |
optional role name(s) that given comment should be restricted to |
< string > array(multi) |
Body |
body |
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/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/cases/instances/CASE-00000000001/comments
Request body
Returns comments from a specified case instance.
GET /server/containers/{containerId}/cases/instances/{caseId}/comments
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
caseId |
identifier of the case instance |
string |
|
Path |
containerId |
container id that case instance belongs to |
string |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Query |
sort |
optional sort column, no default |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Case instance not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/cases/instances/CASE-00000000001/comments
Example HTTP response
Response 200
{
"comments": [
{
"id": "f15419b6-1967-479b-8509-066f579c59e1",
"author": "baAdmin",
"text": "Updated case with new ad hoc fragment.",
"added-at": {
"java.util.Date": 1540494739762
},
"restricted-to": [
"owner"
]
}
{
"id": "2b072823-7448-4819-9560-01165bc7e805",
"author": "baAdmin",
"text": "Removed hardware preparation requirement.",
"added-at": {
"java.util.Date": 1540494802456
},
"restricted-to": [
"supplier"
]
}
]
}Updates a specified comment in a specified case instance.
PUT /server/containers/{containerId}/cases/instances/{caseId}/comments/{caseCommentId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
caseCommentId |
identifier of the comment to be updated |
string |
Path |
caseId |
identifier of the case instance |
string |
Path |
containerId |
container id that case instance belongs to |
string |
Query |
author |
optional user id to be used instead of authenticated user - only when bypass authenticated user is enabled |
string |
Query |
restrictedTo |
optional role name(s) that given comment should be restricted to |
< string > array(multi) |
Body |
body |
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/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/cases/instances/CASE-00000000001/comments/xxx-yyy-zzz
Request body
Deletes a specified comment in a specified case instance.
DELETE /server/containers/{containerId}/cases/instances/{caseId}/comments/{caseCommentId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
caseCommentId |
identifier of the comment to be removed |
string |
Path |
caseId |
identifier of the case instance |
string |
Path |
containerId |
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/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/cases/instances/CASE-00000000001/comments/xxx-yyy-zzz
Returns milestones for a specified case instance.
GET /server/containers/{containerId}/cases/instances/{caseId}/milestones
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
caseId |
identifier of the case instance |
string |
|
Path |
containerId |
container id that case instance belongs to |
string |
|
Query |
achievedOnly |
optional flag that allows to control which milestones to load - achieved only or actives ones too, defaults to true |
boolean |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Case instance not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/cases/instances/CASE-00000000001/milestones
Example HTTP response
Response 200
{
"milestones": [
{
"milestone-name": "Milestone 1: Order placed",
"milestone-id": "1",
"milestone-achieved": false,
"milestone-achieved-at": null,
"milestone-status": "Available"
},
{
"milestone-name": "Hardware spec ready",
"milestone-id": "2",
"milestone-achieved": false,
"milestone-achieved-at": null,
"milestone-status": "Available"
},
{
"milestone-name": "Manager decision",
"milestone-id": "3",
"milestone-achieved": false,
"milestone-achieved-at": null,
"milestone-status": "Available"
},
{
"milestone-name": "Milestone 2: Order shipped",
"milestone-id": "_343B90CD-AA19-4894-B63C-3CE1906E6FD1",
"milestone-achieved": false,
"milestone-achieved-at": null,
"milestone-status": "Available"
},
{
"milestone-name": "Milestone 3: Delivered to customer",
"milestone-id": "_52AFA23F-C087-4519-B8F2-BABCC31D68A6",
"milestone-achieved": false,
"milestone-achieved-at": null,
"milestone-status": "Available"
}
]
}Returns node instances for a specified case instance.
GET /server/containers/{containerId}/cases/instances/{caseId}/nodes/instances
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
caseId |
identifier of the case instance |
string |
|
Path |
containerId |
container id that case instance belongs to |
string |
|
Query |
completed |
optional flag that allows to control which node instances to load - active or completed, defaults to false loading only active ones |
boolean |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Case instance not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/cases/instances/CASE-00000000001/nodes/instances
Example HTTP response
Response 200
{
"node-instance": [
{
"node-instance-id": 0,
"node-name": "Prepare hardware spec",
"process-instance-id": 26,
"work-item-id": 35,
"container-id": "itorders_1.0.0-SNAPSHOT",
"start-date": {
"java.util.Date": 1540474204152
},
"node-id": "_BFA6002D-0917-42CE-81AD-2A15EC814684",
"node-type": "HumanTaskNode",
"node-connection": null,
"node-completed": false,
"reference-id": null,
"sla-compliance": 0,
"sla-due-date": null
},
{
"node-instance-id": 1,
"node-name": "Milestone 1: Order placed",
"process-instance-id": 26,
"work-item-id": null,
"container-id": "itorders_1.0.0-SNAPSHOT",
"start-date": {
"java.util.Date": 1540474204156
},
"node-id": "_DCD97847-6E3C-4C5E-9EE3-221C04BE42ED",
"node-type": "MilestoneNode",
"node-connection": null,
"node-completed": false,
"reference-id": null,
"sla-compliance": 0,
"sla-due-date": null
},
{
"node-instance-id": 1,
"node-name": "Place order",
"process-instance-id": 34,
"work-item-id": 46,
"container-id": "itorders_1.0.0-SNAPSHOT",
"start-date": {
"java.util.Date": 1540504523493
},
"node-id": "_FCADC388-8A68-40E1-94A7-4F8A7D2B21C2",
"node-type": "HumanTaskNode",
"node-connection": "_384EFF84-BB14-4917-89C3-32DF4ACA1878",
"node-completed": false,
"reference-id": null,
"sla-compliance": 0,
"sla-due-date": null
}
]
}Returns process instances in a specified case instance.
GET /server/containers/{containerId}/cases/instances/{caseId}/processes/instances
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
caseId |
identifier of the case instance |
string |
|
Path |
containerId |
container id that case instance belongs to |
string |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Query |
sort |
optional sort column, no default |
string |
|
Query |
sortOrder |
optional sort direction (asc, desc) - defaults to asc |
boolean |
|
Query |
status |
optional process instance status (active, completed, aborted) - defaults ot active (1) only |
< enum (1, 2, 3) > array(multi) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Case instance not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/cases/instances/CASE-00000000001/processes/instances
Example HTTP response
Response 200
{
"process-instance": [
{
"process-instance-id": 26,
"process-id": "itorders.orderhardware",
"process-name": "Order for IT hardware",
"process-version": "1.0",
"process-instance-state": 1,
"container-id": "itorders_1.0.0-SNAPSHOT",
"initiator": "baAdmin",
"start-date": {
"java.util.Date": 1540474204152
},
"process-instance-desc": "Order for IT hardware",
"correlation-key": "IT-0000000006",
"parent-instance-id": -1,
"sla-compliance": 0,
"sla-due-date": null,
"active-user-tasks": null,
"process-instance-variables": null
},
{
"process-instance-id": 34,
"process-id": "itorders-data.place-order",
"process-name": "place-order",
"process-version": "1.0",
"process-instance-state": 1,
"container-id": "itorders_1.0.0-SNAPSHOT",
"initiator": "baAdmin",
"start-date": {
"java.util.Date": 1540504523492
},
"process-instance-desc": "Order IT-0000000006",
"correlation-key": "IT-0000000006:itorders-data.place-order:1540504523491",
"parent-instance-id": 26,
"sla-compliance": 0,
"sla-due-date": null,
"active-user-tasks": null,
"process-instance-variables": null
}
]
}Adds a dynamic subprocess to a specified case instance.
POST /server/containers/{containerId}/cases/instances/{caseId}/processes/{processId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
caseId |
identifier of the case instance |
string |
Path |
containerId |
container id that case instance belongs to |
string |
Path |
processId |
process id of the subprocess to be added |
string |
Body |
body |
data for dynamic subprocess |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
404 |
Case instance not found |
No Content |
500 |
Unexpected error |
No Content |
Consumes
-
application/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/cases/instances/CASE-00000000001/processes/placeOrder
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>Returns role assignments for a specified case instance.
GET /server/containers/{containerId}/cases/instances/{caseId}/roles
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
caseId |
identifier of the case instance |
string |
Path |
containerId |
container id that case instance belongs to |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Case instance not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/cases/instances/CASE-00000000001/roles
Example HTTP response
Response 200
{
"role-assignments": [
{
"name": "owner",
"users": [
"baAdmin"
],
"groups": []
},
{
"name": "manager",
"users": [
"baAdmin"
],
"groups": []
},
{
"name": "supplier",
"users": [],
"groups": [
"IT"
]
}
]
}Assigns a specified case role to a specified user and group for a specified case instance.
PUT /server/containers/{containerId}/cases/instances/{caseId}/roles/{caseRoleName}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
caseId |
identifier of the case instance |
string |
Path |
caseRoleName |
name of the case role the assignment should be set |
string |
Path |
containerId |
container id that case instance belongs to |
string |
Query |
group |
group to be aded to case role for given case instance |
string |
Query |
user |
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/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/cases/instances/CASE-00000000001/roles/owner?group=string&user=string
Removes an assigned case role from a specified user and group for a specified case instance.
DELETE /server/containers/{containerId}/cases/instances/{caseId}/roles/{caseRoleName}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
caseId |
identifier of the case instance |
string |
Path |
caseRoleName |
name of the case role the assignment should be removed |
string |
Path |
containerId |
container id that case instance belongs to |
string |
Query |
group |
group to be removed from case role for given case instance |
string |
Query |
user |
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/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/cases/instances/CASE-00000000001/roles/owner?group=string&user=string
Returns stages for a specified case instance.
GET /server/containers/{containerId}/cases/instances/{caseId}/stages
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
caseId |
identifier of the case instance |
string |
|
Path |
containerId |
container id that case instance belongs to |
string |
|
Query |
activeOnly |
optional flag that allows to control which stages to load - active only or completed ones too, defaults to true |
boolean |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Case instance not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/cases/instances/CASE-00000000001/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": "2018-10-25T18:34:44.456Z",
"node-id": "string",
"node-type": "string",
"node-connection": "string",
"node-completed": true,
"reference-id": 0,
"sla-compliance": 0,
"sla-due-date": "2018-10-25T18:34:44.456Z"
}
]
}
]
}Adds dynamic subprocess identified by process id to stage within case instance
POST /server/containers/{containerId}/cases/instances/{caseId}/stages/{caseStageId}/processes/{processId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
caseId |
identifier of the case instance |
string |
Path |
caseStageId |
identifier of the stage within case instance where dynamic subprocess should be added |
string |
Path |
containerId |
container id that case instance belongs to |
string |
Path |
processId |
process id of the subprocess to be added |
string |
Body |
body |
data for dynamic subprocess |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
404 |
Case instance not found |
No Content |
500 |
Unexpected error |
No Content |
Consumes
-
application/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/cases/instances/CASE-00000000001/stages/stageOne/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 a dynamic user task or service task to the specified stage in a specified case instance.
POST /server/containers/{containerId}/cases/instances/{caseId}/stages/{caseStageId}/tasks
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
caseId |
identifier of the case instance |
string |
Path |
caseStageId |
identifier of the stage within case instance where dynamic task should be added |
string |
Path |
containerId |
container id that case instance belongs to |
string |
Body |
body |
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/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/cases/instances/CASE-00000000001/stages/stageOne/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 a specified ad hoc fragment in the specified stage of a specified case instance.
PUT /server/containers/{containerId}/cases/instances/{caseId}/stages/{caseStageId}/tasks/{nodeName}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
caseId |
identifier of the case instance |
string |
Path |
caseStageId |
identifier of the stage within case instance where adhoc fragment should be triggered |
string |
Path |
containerId |
container id that case instance belongs to |
string |
Path |
nodeName |
name of the adhoc fragment to be triggered |
string |
Body |
body |
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/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/cases/instances/CASE-00000000001/stages/stageOne/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 a dynamic user task or service task to the specified case instance.
POST /server/containers/{containerId}/cases/instances/{caseId}/tasks
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
caseId |
identifier of the case instance |
string |
Path |
containerId |
container id that case instance belongs to |
string |
Body |
body |
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/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/cases/instances/CASE-00000000001/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 a specified ad hoc fragment in a specified case instance.
PUT /server/containers/{containerId}/cases/instances/{caseId}/tasks/{nodeName}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
caseId |
identifier of the case instance |
string |
Path |
containerId |
container id that case instance belongs to |
string |
Path |
nodeName |
name of the adhoc fragment to be triggered |
string |
Body |
body |
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/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/cases/instances/CASE-00000000001/tasks/sampleTask
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 a new case instance for a specified case definition.
POST /server/containers/{containerId}/cases/{caseDefId}/instances
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
caseDefId |
case definition id that new instance should be created from |
string |
Path |
containerId |
container id where the case definition resides |
string |
Body |
body |
optional CaseFile with variables and/or case role assignments |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Successfull response |
No Content |
404 |
Case definition or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Consumes
-
application/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/cases/CASE-0000000001/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
CASE-0000000012Returns case instances for a specified case definition.
GET /server/containers/{containerId}/cases/{caseDefId}/instances
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
caseDefId |
case definition id that should be used to filter case instances |
string |
|
Path |
containerId |
container id that should be used to filter case instances |
string |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Query |
sort |
optional sort column, no default |
string |
|
Query |
sortOrder |
optional sort direction (asc, desc) - defaults to asc |
boolean |
|
Query |
status |
optional case instance status (open, closed, canceled) - defaults ot open (1) only |
< enum (open, closed, cancelled) > array(multi) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/cases/CASE-00000000001/instances
Example HTTP response
Response 200
{
"instances": [
{
"case-id": "IT-0000000006",
"case-description": "Order for IT hardware",
"case-owner": "baAdmin",
"case-status": 1,
"case-definition-id": "itorders.orderhardware",
"container-id": "itorders_1.0.0-SNAPSHOT",
"case-started-at": 1540474204152,
"case-completed-at": null,
"case-completion-msg": "",
"case-sla-compliance": 0,
"case-sla-due-date": null,
"case-file": null,
"case-milestones": null,
"case-stages": null,
"case-roles": null
},
{
"case-id": "IT-0000000011",
"case-description": "Order for IT hardware",
"case-owner": "baAdmin",
"case-status": 1,
"case-definition-id": "itorders.orderhardware",
"container-id": "itorders_1.0.0-SNAPSHOT6",
"case-started-at": 1540496734746,
"case-completed-at": null,
"case-completion-msg": "",
"case-sla-compliance": 0,
"case-sla-due-date": null,
"case-file": null,
"case-milestones": null,
"case-stages": null,
"case-roles": null
}
]
}Reopens a closed case instance for a specified case definition.
PUT /server/containers/{containerId}/cases/{caseDefId}/instances/{caseId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
caseDefId |
case definition id that new instance should be created from |
string |
Path |
caseId |
identifier of the case instance |
string |
Path |
containerId |
container id where the case definition resides |
string |
Body |
body |
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/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/cases/evaluation/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>Case Queries
Returns a specified case definition from all KIE containers.
GET /server/queries/cases
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
filter |
case definition id or name that case definitions will be filtered by |
string |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Query |
sort |
optional sort column, no default |
string |
|
Query |
sortOrder |
optional sort direction (asc, desc) - defaults to asc |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/queries/cases?filter=string
Example HTTP response
Response 200
{
"definitions": [
{
"name": "Order for IT hardware",
"id": "itorders.orderhardware",
"version": "1.0",
"case-id-prefix": "IT",
"container-id": "itorders_1.0.0-SNAPSHOT2",
"adhoc-fragments": [
{
"name": "Prepare hardware spec",
"type": "HumanTaskNode"
},
{
"name": "Milestone 1: Order placed",
"type": "MilestoneNode"
},
{
"name": "Milestone 2: Order shipped",
"type": "MilestoneNode"
},
{
"name": "Milestone 3: Delivered to customer",
"type": "MilestoneNode"
},
{
"name": "Hardware spec ready",
"type": "MilestoneNode"
},
{
"name": "Manager decision",
"type": "MilestoneNode"
}
],
"roles": {
"owner": 1,
"manager": 1,
"supplier": 2
},
"milestones": [
{
"milestone-name": "Milestone 1: Order placed",
"milestone-id": "_DCD97847-6E3C-4C5E-9EE3-221C04BE42ED",
"milestone-mandatory": false
},
{
"milestone-name": "Milestone 2: Order shipped",
"milestone-id": "_343B90CD-AA19-4894-B63C-3CE1906E6FD1",
"milestone-mandatory": false
},
{
"milestone-name": "Milestone 3: Delivered to customer",
"milestone-id": "_52AFA23F-C087-4519-B8F2-BABCC31D68A6",
"milestone-mandatory": false
},
{
"milestone-name": "Hardware spec ready",
"milestone-id": "_483CF785-96DD-40C1-9148-4CFAFAE5778A",
"milestone-mandatory": false
},
{
"milestone-name": "Manager decision",
"milestone-id": "_79953D58-25DB-4FD6-94A0-DFC6EA2D0339",
"milestone-mandatory": false
}
],
"stages": []
},
{
"name": "Order for IT hardware",
"id": "itorders.orderhardware",
"version": "1.0",
"case-id-prefix": "IT",
"container-id": "itorders_1.0.0-SNAPSHOT3",
"adhoc-fragments": [
{
"name": "Prepare hardware spec",
"type": "HumanTaskNode"
},
{
"name": "Milestone 1: Order placed",
"type": "MilestoneNode"
},
{
"name": "Milestone 2: Order shipped",
"type": "MilestoneNode"
},
{
"name": "Milestone 3: Delivered to customer",
"type": "MilestoneNode"
},
{
"name": "Hardware spec ready",
"type": "MilestoneNode"
},
{
"name": "Manager decision",
"type": "MilestoneNode"
}
],
"roles": {
"owner": 1,
"manager": 1,
"supplier": 2
},
"milestones": [
{
"milestone-name": "Milestone 1: Order placed",
"milestone-id": "_DCD97847-6E3C-4C5E-9EE3-221C04BE42ED",
"milestone-mandatory": false
},
{
"milestone-name": "Milestone 2: Order shipped",
"milestone-id": "_343B90CD-AA19-4894-B63C-3CE1906E6FD1",
"milestone-mandatory": false
},
{
"milestone-name": "Milestone 3: Delivered to customer",
"milestone-id": "_52AFA23F-C087-4519-B8F2-BABCC31D68A6",
"milestone-mandatory": false
},
{
"milestone-name": "Hardware spec ready",
"milestone-id": "_483CF785-96DD-40C1-9148-4CFAFAE5778A",
"milestone-mandatory": false
},
{
"milestone-name": "Manager decision",
"milestone-id": "_79953D58-25DB-4FD6-94A0-DFC6EA2D0339",
"milestone-mandatory": false
}
],
"stages": []
}
]
}Returns cases instances with authentication checks.
GET /server/queries/cases/instances
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
dataItemName |
data item name that case instances will be filtered by |
string |
|
Query |
dataItemValue |
data item value that case instances will be filtered by |
string |
|
Query |
owner |
case instance owner that case instances will be filtered by |
string |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Query |
sort |
optional sort column, no default |
string |
|
Query |
sortOrder |
optional sort direction (asc, desc) - defaults to asc |
boolean |
|
Query |
status |
optional case instance status (open, closed, canceled) - defaults ot open (1) only |
< enum (open, closed, cancelled) > array(multi) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/queries/cases/instances
Example HTTP response
Response 200
{
"instances": [
{
"case-id": "IT-0000000006",
"case-description": "Order for IT hardware",
"case-owner": "baAdmin",
"case-status": 1,
"case-definition-id": "itorders.orderhardware",
"container-id": "itorders_1.0.0-SNAPSHOT",
"case-started-at": 1540474204152,
"case-completed-at": null,
"case-completion-msg": "",
"case-sla-compliance": 0,
"case-sla-due-date": null,
"case-file": null,
"case-milestones": null,
"case-stages": null,
"case-roles": null
},
{
"case-id": "IT-0000000011",
"case-description": "Order for IT hardware",
"case-owner": "baAdmin",
"case-status": 1,
"case-definition-id": "itorders.orderhardware",
"container-id": "itorders_1.0.0-SNAPSHOT6",
"case-started-at": 1540496734746,
"case-completed-at": null,
"case-completion-msg": "",
"case-sla-compliance": 0,
"case-sla-due-date": null,
"case-file": null,
"case-milestones": null,
"case-stages": null,
"case-roles": null
}
]
}Returns case file data items for a specified case instance.
GET /server/queries/cases/instances/{caseId}/caseFile
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
caseId |
case instance identifier that data items should belong to |
string |
|
Query |
name |
optionally filter by data item names |
< string > array(multi) |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Query |
type |
optionally filter by data item types |
< string > array(multi) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/queries/cases/instances/CASE-0000000001/caseFile
Example HTTP response
Response 200
{
"instances": [
{
"case-id": "IT-0000000006",
"name": "hwSpecNew",
"value": "New content for hardware specification.",
"type": "java.lang.String",
"last-modified-by": "baAdmin",
"last-modified": 1540502077279
},
{
"case-id": "IT-0000000006",
"name": "milestone-mandatory",
"value": "false",
"type": "java.lang.Boolean",
"last-modified-by": "baAdmin",
"last-modified": 1540499389943
}
]
}Returns tasks for business administrators in a specified case instance.
GET /server/queries/cases/instances/{caseId}/tasks/instances/admins
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
caseId |
case instance identifier that tasks should belong to |
string |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Query |
sort |
optional sort column, no default |
string |
|
Query |
sortOrder |
optional sort direction (asc, desc) - defaults to asc |
boolean |
|
Query |
status |
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 user id to be used instead of authenticated user - only when bypass authenticated user is enabled |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/queries/cases/instances/CASE-00000000001/tasks/instances/admins
Example HTTP response
Response 200
{
"task-summary": [
{
"task-id": "2",
"task-name": "Self Evaluation",
"task-subject": "",
"task-description": "Please perform a self-evalutation.",
"task-status": "Ready",
"task-priority": "0",
"task-is-skippable": "false",
"task-created-by": "John",
"task-created-on": "2016-04-05T15:09:14.206+02:00",
"task-activation-time": "2016-04-05T15:09:14.206+02:00",
"task-proc-inst-id": "2",
"task-proc-def-id": "evaluation",
"task-container-id": "myContainer",
"task-parent-id": "-1"
},
{
"task-id": "1",
"task-name": "Self Evaluation",
"task-subject": "",
"task-description": "Please perform a self-evalutation.",
"task-status": "InProgress",
"task-priority": "0",
"task-is-skippable": "false",
"task-actual-owner": "kiesu",
"task-created-by": "John",
"task-created-on": "2016-04-05T15:05:06.508+02:00",
"task-activation-time": "2016-04-05T15:05:06.508+02:00",
"task-proc-inst-id": "1",
"task-proc-def-id": "evaluation",
"task-container-id": "myContainer",
"task-parent-id": "-1"
}
]
}Returns tasks for potential owners in a specified case instance.
GET /server/queries/cases/instances/{caseId}/tasks/instances/pot-owners
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
caseId |
case instance identifier that tasks should belong to |
string |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Query |
sort |
optional sort column, no default |
string |
|
Query |
sortOrder |
optional sort direction (asc, desc) - defaults to asc |
boolean |
|
Query |
status |
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 user id to be used instead of authenticated user - only when bypass authenticated user is enabled |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/queries/cases/instances/CASE-00000000011/tasks/instances/pot-owners
Example HTTP response
Response 200
{
"task-summary": [
{
"task-id": "2",
"task-name": "Self Evaluation",
"task-subject": "",
"task-description": "Please perform a self-evalutation.",
"task-status": "Ready",
"task-priority": "0",
"task-is-skippable": "false",
"task-created-by": "John",
"task-created-on": "2016-04-05T15:09:14.206+02:00",
"task-activation-time": "2016-04-05T15:09:14.206+02:00",
"task-proc-inst-id": "2",
"task-proc-def-id": "evaluation",
"task-container-id": "myContainer",
"task-parent-id": "-1"
},
{
"task-id": "1",
"task-name": "Self Evaluation",
"task-subject": "",
"task-description": "Please perform a self-evalutation.",
"task-status": "InProgress",
"task-priority": "0",
"task-is-skippable": "false",
"task-actual-owner": "kiesu",
"task-created-by": "John",
"task-created-on": "2016-04-05T15:05:06.508+02:00",
"task-activation-time": "2016-04-05T15:05:06.508+02:00",
"task-proc-inst-id": "1",
"task-proc-def-id": "evaluation",
"task-container-id": "myContainer",
"task-parent-id": "-1"
}
]
}Returns tasks for stakeholders in a specified case instance.
GET /server/queries/cases/instances/{caseId}/tasks/instances/stakeholders
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
caseId |
case instance identifier that tasks should belong to |
string |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Query |
sort |
optional sort column, no default |
string |
|
Query |
sortOrder |
optional sort direction (asc, desc) - defaults to asc |
boolean |
|
Query |
status |
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 user id to be used instead of authenticated user - only when bypass authenticated user is enabled |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/queries/cases/instances/CASE-0000000001/tasks/instances/stakeholders
Example HTTP response
Response 200
{
"task-summary": [
{
"task-id": "2",
"task-name": "Self Evaluation",
"task-subject": "",
"task-description": "Please perform a self-evalutation.",
"task-status": "Ready",
"task-priority": "0",
"task-is-skippable": "false",
"task-created-by": "John",
"task-created-on": "2016-04-05T15:09:14.206+02:00",
"task-activation-time": "2016-04-05T15:09:14.206+02:00",
"task-proc-inst-id": "2",
"task-proc-def-id": "evaluation",
"task-container-id": "myContainer",
"task-parent-id": "-1"
},
{
"task-id": "1",
"task-name": "Self Evaluation",
"task-subject": "",
"task-description": "Please perform a self-evalutation.",
"task-status": "InProgress",
"task-priority": "0",
"task-is-skippable": "false",
"task-actual-owner": "kiesu",
"task-created-by": "John",
"task-created-on": "2016-04-05T15:05:06.508+02:00",
"task-activation-time": "2016-04-05T15:05:06.508+02:00",
"task-proc-inst-id": "1",
"task-proc-def-id": "evaluation",
"task-container-id": "myContainer",
"task-parent-id": "-1"
}
]
}Returns a specified process associated with case definitions from all KIE containers.
GET /server/queries/cases/processes
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
filter |
process definition id or name that process definitions will be filtered by |
string |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Query |
sort |
optional sort column, no default |
string |
|
Query |
sortOrder |
optional sort direction (asc, desc) - defaults to asc |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/queries/cases/processes?filter=string
Example HTTP response
Response 200
{
"processes": [
{
"associatedEntities": null,
"serviceTasks": null,
"processVariables": null,
"reusableSubProcesses": null,
"process-id": "Employee_Rostering.Process1",
"process-name": "Process1",
"process-version": "1.0",
"package": "employeerostering.employeerostering",
"container-id": "employee-rostering",
"dynamic": false
}
]
}Returns cases instances that involve the querying user in a specified role.
GET /server/queries/cases/{caseRoleName}/instances
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
caseRoleName |
case role that instances should be found for |
string |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Query |
sort |
optional sort column, no default |
string |
|
Query |
sortOrder |
optional sort direction (asc, desc) - defaults to asc |
boolean |
|
Query |
status |
optional case instance status (open, closed, canceled) - defaults ot open (1) only |
< enum (open, closed, cancelled) > array(multi) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/queries/cases/owner/instances
Example HTTP response
Response 200
{
"instances": [
{
"case-id": "IT-0000000006",
"case-description": "Order for IT hardware",
"case-owner": "baAdmin",
"case-status": 1,
"case-definition-id": "itorders.orderhardware",
"container-id": "itorders_1.0.0-SNAPSHOT",
"case-started-at": 1540474204152,
"case-completed-at": null,
"case-completion-msg": "",
"case-sla-compliance": 0,
"case-sla-due-date": null,
"case-file": null,
"case-milestones": null,
"case-stages": null,
"case-roles": null
},
{
"case-id": "IT-0000000011",
"case-description": "Order for IT hardware",
"case-owner": "baAdmin",
"case-status": 1,
"case-definition-id": "itorders.orderhardware",
"container-id": "itorders_1.0.0-SNAPSHOT6",
"case-started-at": 1540496734746,
"case-completed-at": null,
"case-completion-msg": "",
"case-sla-compliance": 0,
"case-sla-due-date": null,
"case-file": null,
"case-milestones": null,
"case-stages": null,
"case-roles": null
}
]
}Returns processes associated with case definitions in a specified KIE container.
GET /server/queries/cases/{containerId}/processes
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
containerId |
container id that process definitions should be filtered by |
string |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Query |
sort |
optional sort column, no default |
string |
|
Query |
sortOrder |
optional sort direction (asc, desc) - defaults to asc |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/queries/cases/evaluation_1.0.0-SNAPSHOT/processes
Example HTTP response
Response 200
{
"processes": [
{
"associatedEntities": null,
"serviceTasks": null,
"processVariables": null,
"reusableSubProcesses": null,
"process-id": "Employee_Rostering.Process1",
"process-name": "Process1",
"process-version": "1.0",
"package": "employeerostering.employeerostering",
"container-id": "employee-rostering",
"dynamic": false
}
]
}Custom Queries
Returns all custom query definitions.
GET /server/queries/definitions
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/queries/definitions
Example HTTP response
Response 200
{
"queries": [
{
"query-name": "tasksMonitoring",
"query-source": "java:jboss/datasources/ExampleDS",
"query-expression": "select p.processName, p.externalId, t.taskId, t.taskName, t.status, t.createdDate, t.startDate, t.endDate, t.processInstanceId, t.userId, t.duration from ProcessInstanceLog p inner join BAMTaskSummary t on (t.processInstanceId = p.processInstanceId) inner join (select min(pk) as pk from BAMTaskSummary group by taskId) d on t.pk = d.pk",
"query-target": "CUSTOM",
"query-columns": {}
},
{
"query-name": "jbpmExecutionErrorList",
"query-source": "java:jboss/datasources/ExampleDS",
"query-expression": "select eri.ERROR_ACK, eri.ERROR_ACK_BY, eri.ERROR_ACK_AT, eri.ACTIVITY_ID, eri.ACTIVITY_NAME, eri.DEPLOYMENT_ID, eri.ERROR_DATE, eri.ERROR_ID, eri.ERROR_MSG, eri.JOB_ID, eri.PROCESS_ID, eri.PROCESS_INST_ID, eri.ERROR_TYPE from ExecutionErrorInfo eri",
"query-target": "CUSTOM",
"query-columns": {}
},
{
"query-name": "jbpmRequestList",
"query-source": "java:jboss/datasources/ExampleDS",
"query-expression": "select ri.id, ri.timestamp, ri.status, ri.commandName, ri.message, ri.businessKey, ri.retries, ri.executions, pil.processName, pil.processInstanceId, pil.processInstanceDescription, ri.deploymentId from RequestInfo ri left join ProcessInstanceLog pil on pil.processInstanceId=ri.processInstanceId",
"query-target": "CUSTOM",
"query-columns": {}
}
]
}Returns the results of a specified custom query on a specified KIE container and filters the results based on a provided builder or filter request body.
POST /server/queries/definitions/containers/{containerId}/query/{queryName}/filtered-data
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
containerId |
container id to filter queries |
string |
|
Path |
queryName |
identifier of the query definition to be used for query |
string |
|
Query |
builder |
optional identifier of the query builder to be used for query conditions |
string |
|
Query |
mapper |
identifier of the query mapper to be used when transforming results |
string |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Body |
body |
optional query filter specification represented as QueryFilterSpec |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
400 |
Query parameters or filter spec provide invalid conditions |
No Content |
500 |
Unexpected error |
No Content |
Consumes
-
application/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/queries/definitions/containers/evaluation_1.0.0-SNAPSHOT/query/customQuery/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
{
"process-instance": [
{
"process-instance-id": 1,
"process-id": "Employee_Rostering.Process1",
"process-name": "Process1",
"process-version": "1.0",
"process-instance-state": 1,
"container-id": "employee-rostering",
"initiator": "baAdmin",
"start-date": {
"java.util.Date": 1539184095041
},
"process-instance-desc": "Process1",
"correlation-key": "1",
"parent-instance-id": -1,
"sla-compliance": 0,
"sla-due-date": null,
"active-user-tasks": null,
"process-instance-variables": null
},
{
"process-instance-id": 2,
"process-id": "Employee_Rostering.Process2",
"process-name": "Process2",
"process-version": "1.0",
"process-instance-state": 1,
"container-id": "employee-rostering",
"initiator": "baAdmin",
"start-date": {
"java.util.Date": 1539184303976
},
"process-instance-desc": "Process2",
"correlation-key": "2",
"parent-instance-id": -1,
"sla-compliance": 0,
"sla-due-date": null,
"active-user-tasks": null,
"process-instance-variables": null
}
]
}Registers a custom query definition.
POST /server/queries/definitions/{queryName}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
queryName |
identifier of the query definition to be registered |
string |
Body |
body |
query definition represented as QueryDefinition |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Successfull response |
No Content |
409 |
Query with given name already exists |
No Content |
500 |
Unexpected error |
No Content |
Consumes
-
application/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/queries/definitions/customQuery
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": "jbpmProcessInstancesWithVariables1",
"query-source": "java:jboss/datasources/ExampleDS",
"query-expression": "select vil.processInstanceId, vil.processId, vil.id, vil.variableId, vil.value from VariableInstanceLog vil where vil.id in (select MAX(v.id) from VariableInstanceLog v group by v.variableId, v.processInstanceId)",
"query-target": "CUSTOM",
"query-columns": {
"PROCESSINSTANCEID": "NUMBER",
"VARIABLEID": "LABEL",
"ID": "NUMBER",
"VALUE": "LABEL",
"PROCESSID": "LABEL"
}
}Returns information about a specified custom query.
GET /server/queries/definitions/{queryName}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
queryName |
identifier of the query definition to be retrieved |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Query definition with given name not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/queries/definitions/customQuery
Example HTTP response
Response 200
{
"query-name": "jbpmProcessInstancesWithVariables1",
"query-source": "java:jboss/datasources/ExampleDS",
"query-expression": "select vil.processInstanceId, vil.processId, vil.id, vil.variableId, vil.value from VariableInstanceLog vil where vil.id in (select MAX(v.id) from VariableInstanceLog v group by v.variableId, v.processInstanceId)",
"query-target": "CUSTOM",
"query-columns": {
"PROCESSINSTANCEID": "NUMBER",
"VARIABLEID": "LABEL",
"ID": "NUMBER",
"VALUE": "LABEL",
"PROCESSID": "LABEL"
}
}Replaces existing custom query definition or registers it as new if the query does not already exist.
PUT /server/queries/definitions/{queryName}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
queryName |
identifier of the query definition to be replaced |
string |
Body |
body |
query definition represented as QueryDefinition |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Consumes
-
application/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/queries/definitions/customQuery
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": "jbpmProcessInstancesWithVariables1",
"query-source": "java:jboss/datasources/ExampleDS",
"query-expression": "select vil.processInstanceId, vil.processId, vil.id, vil.variableId, vil.value from VariableInstanceLog vil where vil.id in (select MAX(v.id) from VariableInstanceLog v group by v.variableId, v.processInstanceId)",
"query-target": "CUSTOM",
"query-columns": {
"PROCESSINSTANCEID": "NUMBER",
"VARIABLEID": "LABEL",
"ID": "NUMBER",
"VALUE": "LABEL",
"PROCESSID": "LABEL"
}
}Deletes a specified custom query.
DELETE /server/queries/definitions/{queryName}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
queryName |
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/json -
application/xml
Example HTTP request
Request path
/server/queries/definitions/customQuery
Returns the results of a specified custom query.
GET /server/queries/definitions/{queryName}/data
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
queryName |
identifier of the query definition to be used for query |
string |
|
Query |
mapper |
identifier of the query mapper to be used when transforming results |
string |
|
Query |
orderBy |
optional sort order |
string |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Query definition with given name not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/queries/definitions/customQuery/data?mapper=string
Example HTTP response
Response 200
{
"process-instance": [
{
"process-instance-id": 1,
"process-id": "Employee_Rostering.Process1",
"process-name": "Process1",
"process-version": "1.0",
"process-instance-state": 1,
"container-id": "employee-rostering",
"initiator": "baAdmin",
"start-date": {
"java.util.Date": 1539184095041
},
"process-instance-desc": "Process1",
"correlation-key": "1",
"parent-instance-id": -1,
"sla-compliance": 0,
"sla-due-date": null,
"active-user-tasks": null,
"process-instance-variables": null
},
{
"process-instance-id": 2,
"process-id": "Employee_Rostering.Process2",
"process-name": "Process2",
"process-version": "1.0",
"process-instance-state": 1,
"container-id": "employee-rostering",
"initiator": "baAdmin",
"start-date": {
"java.util.Date": 1539184303976
},
"process-instance-desc": "Process2",
"correlation-key": "2",
"parent-instance-id": -1,
"sla-compliance": 0,
"sla-due-date": null,
"active-user-tasks": null,
"process-instance-variables": null
}
]
}Returns the results of a specified custom query and filters the results based on a provided builder or filter request body.
POST /server/queries/definitions/{queryName}/filtered-data
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
queryName |
identifier of the query definition to be used for query |
string |
|
Query |
builder |
optional identifier of the query builder to be used for query conditions |
string |
|
Query |
mapper |
identifier of the query mapper to be used when transforming results |
string |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Body |
body |
optional query filter specification represented as QueryFilterSpec |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
400 |
Query parameters or filter spec provide invalid conditions |
No Content |
500 |
Unexpected error |
No Content |
Consumes
-
application/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/queries/definitions/customQuery/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
{
"process-instance": [
{
"process-instance-id": 1,
"process-id": "Employee_Rostering.Process1",
"process-name": "Process1",
"process-version": "1.0",
"process-instance-state": 1,
"container-id": "employee-rostering",
"initiator": "baAdmin",
"start-date": {
"java.util.Date": 1539184095041
},
"process-instance-desc": "Process1",
"correlation-key": "1",
"parent-instance-id": -1,
"sla-compliance": 0,
"sla-due-date": null,
"active-user-tasks": null,
"process-instance-variables": null
},
{
"process-instance-id": 2,
"process-id": "Employee_Rostering.Process2",
"process-name": "Process2",
"process-version": "1.0",
"process-instance-state": 1,
"container-id": "employee-rostering",
"initiator": "baAdmin",
"start-date": {
"java.util.Date": 1539184303976
},
"process-instance-desc": "Process2",
"correlation-key": "2",
"parent-instance-id": -1,
"sla-compliance": 0,
"sla-due-date": null,
"active-user-tasks": null,
"process-instance-variables": null
}
]
}DMN Models
Evaluates decisions for given input
POST /server/containers/{containerId}/dmn
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
Container id to be used to evaluate decisions on |
string |
Body |
body |
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/{containerId}/dmn
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
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
Uploads a new document to KIE Server.
POST /server/documents
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
body |
document content represented as DocumentInstance |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
201 |
successful operation |
string |
500 |
Unexpected error |
No Content |
Consumes
-
application/json -
application/xml
Produces
-
application/json -
application/xml
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 200
a03672e8-8671-4d84-bd14-0ab5a341b80dResponse 201
"string"Returns all documents from KIE Server.
GET /server/documents
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/documents
Example HTTP response
Response 200
{
"document-instances": [
{
"document-id": "001df463-2482-4dd5-abec-4622d16edaee",
"document-name": "MyDocument",
"document-link": "",
"document-size": 18,
"document-last-mod": {
"java.util.Date": 1539936629000
},
"document-content": null
},
{
"document-id": "651a7035-3a90-4a25-bffb-bb09ea14fdac",
"document-name": "MyDocument2",
"document-link": "",
"document-size": 18,
"document-last-mod": {
"java.util.Date": 1539936629000
},
"document-content": null
},
{
"document-id": "c10153e3-dfe7-41a9-811b-edd72c48f5d3",
"document-name": "MyDocument3",
"document-link": "",
"document-size": 18,
"document-last-mod": {
"java.util.Date": 1539936629000
},
"document-content": null
}
]
}Returns information about a specified document.
GET /server/documents/{documentId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
documentId |
document id of a document that should be retruned |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Document with given id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/documents/xxx-yyy-zzz
Example HTTP response
Response 200
{
"document-id": "651a7035-3a90-4a25-bffb-bb09ea14fdac",
"document-name": "MyDocument",
"document-link": "",
"document-size": 18,
"document-last-mod": {
"java.util.Date": 1539936629000
},
"document-content": "VGhpcyBpcyBhIGRvY3VtZW50"
}Updates a specified document in KIE Server.
PUT /server/documents/{documentId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
documentId |
document id of a document that should be updated |
string |
Body |
body |
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/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/documents/xxx-yyy-zzz
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 a specified document from KIE Server.
DELETE /server/documents/{documentId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
documentId |
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/json -
application/xml
Example HTTP request
Request path
/server/documents/xxxx-yyy-zzz
Retrieves document’s content identified by given documentId
GET /server/documents/{documentId}/content
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
documentId |
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/xxx-yyy-zzz/content
Example HTTP response
Response 200
[ "Ynl0ZQ==" ]Jobs
Schedules a job and returns the ID for the new job.
POST /server/jobs
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
containerId |
optional container id that the job should be associated with |
string |
Body |
body |
asynchronous job definition represented as JobRequestInstance |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Consumes
-
application/json -
application/xml
Produces
-
application/json -
application/xml
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
123Retrieves asynchronous jobs filtered by status
GET /server/jobs
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Query |
status |
optional job status (QUEUED, DONE, CANCELLED, ERROR, RETRYING, RUNNING) |
< enum (QUEUED, DONE, CANCELLED, ERROR, RETRYING, RUNNING) > array(multi) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/jobs?status=QUEUED
Example HTTP response
Response 200
{
"request-info-instance": [
{
"request-instance-id": 1,
"request-status": "DONE",
"request-business-key": "job1",
"request-message": "Ready to execute",
"request-retries": 2,
"request-executions": 1,
"request-command": "org.jbpm.executor.commands.LogCleanupCommand",
"request-scheduled-date": {
"java.util.Date": 1540299058209
},
"request-data": null,
"response-data": null,
"request-errors": null,
"request-container-id": null
},
{
"request-instance-id": 2,
"request-status": "DONE",
"request-business-key": "job2",
"request-message": "Ready to execute",
"request-retries": 0,
"request-executions": 0,
"request-command": "java.lang.String",
"request-scheduled-date": {
"java.util.Date": 1540328449419
},
"request-data": null,
"response-data": null,
"request-errors": null,
"request-container-id": null
}
]
}Returns jobs configured to run job commands, such as a job type org.jbpm.executor.commands.LogCleanupCommand.
GET /server/jobs/commands/{cmd}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
cmd |
name of the command that asynchornous jobs should be found for |
string |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Query |
status |
optional job status (QUEUED, DONE, CANCELLED, ERROR, RETRYING, RUNNING) |
< enum (QUEUED, DONE, CANCELLED, ERROR, RETRYING, RUNNING) > array(multi) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/jobs/commands/com.sample.CommandImpl
Example HTTP response
Response 200
{
"request-info-instance": [
{
"request-instance-id": 1,
"request-status": "DONE",
"request-business-key": "job1",
"request-message": "Ready to execute",
"request-retries": 2,
"request-executions": 1,
"request-command": "org.jbpm.executor.commands.LogCleanupCommand",
"request-scheduled-date": {
"java.util.Date": 1540299058209
},
"request-data": null,
"response-data": null,
"request-errors": null,
"request-container-id": null
},
{
"request-instance-id": 2,
"request-status": "DONE",
"request-business-key": "job2",
"request-message": "Ready to execute",
"request-retries": 0,
"request-executions": 0,
"request-command": "java.lang.String",
"request-scheduled-date": {
"java.util.Date": 1540328449419
},
"request-data": null,
"response-data": null,
"request-errors": null,
"request-container-id": null
}
]
}Returns jobs for specified KIE container.
GET /server/jobs/containers/{containerId}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
containerId |
identifier of the container that asynchornous jobs should be found for |
string |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Query |
status |
optional job status (QUEUED, DONE, CANCELLED, ERROR, RETRYING, RUNNING) |
< enum (QUEUED, DONE, CANCELLED, ERROR, RETRYING, RUNNING) > array(multi) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/jobs/containers/evaluation_1.0.0-SNAPSHOT
Example HTTP response
Response 200
{
"request-info-instance": [
{
"request-instance-id": 1,
"request-status": "DONE",
"request-business-key": "job1",
"request-message": "Ready to execute",
"request-retries": 2,
"request-executions": 1,
"request-command": "org.jbpm.executor.commands.LogCleanupCommand",
"request-scheduled-date": {
"java.util.Date": 1540299058209
},
"request-data": null,
"response-data": null,
"request-errors": null,
"request-container-id": null
},
{
"request-instance-id": 2,
"request-status": "DONE",
"request-business-key": "job2",
"request-message": "Ready to execute",
"request-retries": 0,
"request-executions": 0,
"request-command": "java.lang.String",
"request-scheduled-date": {
"java.util.Date": 1540328449419
},
"request-data": null,
"response-data": null,
"request-errors": null,
"request-container-id": null
}
]
}Returns information about a job with a specified business key.
GET /server/jobs/keys/{key}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
key |
identifier of the business key that asynchornous jobs should be found for |
string |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Query |
status |
optional job status (QUEUED, DONE, CANCELLED, ERROR, RETRYING, RUNNING) |
< enum (QUEUED, DONE, CANCELLED, ERROR, RETRYING, RUNNING) > array(multi) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/jobs/keys/custom-job
Example HTTP response
Response 200
{
"request-info-instance": [
{
"request-instance-id": 1,
"request-status": "DONE",
"request-business-key": "job1",
"request-message": "Ready to execute",
"request-retries": 2,
"request-executions": 1,
"request-command": "org.jbpm.executor.commands.LogCleanupCommand",
"request-scheduled-date": {
"java.util.Date": 1540299058209
},
"request-data": null,
"response-data": null,
"request-errors": null,
"request-container-id": null
},
{
"request-instance-id": 2,
"request-status": "DONE",
"request-business-key": "job2",
"request-message": "Ready to execute",
"request-retries": 0,
"request-executions": 0,
"request-command": "java.lang.String",
"request-scheduled-date": {
"java.util.Date": 1540328449419
},
"request-data": null,
"response-data": null,
"request-errors": null,
"request-container-id": null
}
]
}Returns jobs for specified process instance.
GET /server/jobs/processes/instances/{processInstanceId}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
processInstanceId |
identifier of the process instance that asynchornous jobs should be found for |
integer (int64) |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Query |
status |
optional job status (QUEUED, DONE, CANCELLED, ERROR, RETRYING, RUNNING) |
< enum (QUEUED, DONE, CANCELLED, ERROR, RETRYING, RUNNING) > array(multi) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/jobs/processes/instances/123
Example HTTP response
Response 200
{
"request-info-instance": [
{
"request-instance-id": 1,
"request-status": "DONE",
"request-business-key": "job1",
"request-message": "Ready to execute",
"request-retries": 2,
"request-executions": 1,
"request-command": "org.jbpm.executor.commands.LogCleanupCommand",
"request-scheduled-date": {
"java.util.Date": 1540299058209
},
"request-data": null,
"response-data": null,
"request-errors": null,
"request-container-id": null
},
{
"request-instance-id": 2,
"request-status": "DONE",
"request-business-key": "job2",
"request-message": "Ready to execute",
"request-retries": 0,
"request-executions": 0,
"request-command": "java.lang.String",
"request-scheduled-date": {
"java.util.Date": 1540328449419
},
"request-data": null,
"response-data": null,
"request-errors": null,
"request-container-id": null
}
]
}Returns information about a specified job.
GET /server/jobs/{jobId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
jobId |
identifier of the asynchronous job to be retrieved |
integer (int64) |
Query |
withData |
optional flag that indicats if input/output data should be loaded as well |
boolean |
Query |
withErrors |
optional flag that indicats if errors should be loaded as well |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/jobs/123
Example HTTP response
Response 200
{
"request-instance-id": 6,
"request-status": "DONE",
"request-business-key": "job3",
"request-message": "Ready to execute",
"request-retries": 5,
"request-executions": 1,
"request-command": "org.jbpm.executor.commands.LogCleanupCommand",
"request-scheduled-date": {
"java.util.Date": 1540385144520
},
"request-data": {
"retries": "5",
"businessKey": "job3"
},
"response-data": {
"RequestInfoLogsRemoved": 2,
"BAMLogRemoved": 0,
"VariableInstanceLogRemoved": 0,
"ProcessInstanceLogRemoved": 0,
"TaskAuditLogRemoved": 0,
"ErrorInfoLogsRemoved": 0,
"TaskEventLogRemoved": 0,
"TaskVariableLogRemoved": 0,
"NodeInstanceLogRemoved": 0
},
"request-errors": {
"error-info-instance": []
},
"request-container-id": null
}Re-queues a specified job.
PUT /server/jobs/{jobId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
jobId |
identifier of the asynchronous job to be requeued |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
500 |
Unexpected error |
No Content |
Consumes
-
application/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/jobs/123
Deletes a specified job.
DELETE /server/jobs/{jobId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
jobId |
identifier of the asynchronous job to be canceled |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/jobs/123
Updates parameters for job commands, if used.
POST /server/jobs/{jobId}/data
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
jobId |
identifier of the asynchronous job to be updated |
integer (int64) |
Query |
containerId |
optional container id that the job should be associated with |
string |
Body |
body |
data to be updated on the asynchronous job represented as Map |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
500 |
Unexpected error |
No Content |
Consumes
-
application/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/jobs/123/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>KIE Server And KIE Containers
Returns information about the KIE Server. The endpoint for this request is the base URL for the REST API.
GET /server
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server
Example HTTP response
Response 200
{
"response": [
{
"type": "SUCCESS",
"msg": "Kie Server info",
"result": {
"kie-server-info": {
"id": "default-kieserver",
"version": "7.11.0.Final-redhat-00001",
"name": "default-kieserver",
"location": "http://localhost:8080/kie-server/services/rest/server",
"capabilities": [
"KieServer",
"BRM",
"BPM",
"CaseMgmt",
"BPM-UI",
"BRP",
"DMN",
"Swagger"
],
"messages": [
{
"severity": "INFO",
"timestamp": {
"java.util.Date": 1538996199184
},
"content": [
"Server KieServerInfo{serverId='default-kieserver', version='7.11.0.Final-redhat-00001', name='default-kieserver', location='http://localhost:8080/kie-server/services/rest/server', capabilities=[KieServer, BRM, BPM, CaseMgmt, BPM-UI, BRP, DMN, Swagger], messages=null}started successfully at Mon Oct 08 06:56:39 EDT 2018"
]
}
]
}
}
}
]
}Executes one or more KIE Server commands for server-related or container-related operations
POST /server/config
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
body |
command script payload |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Consumes
-
application/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/config
Request body
{
"commands": [
{
"create-container": {
"container": {
"status": "STARTED",
"container-id": "command-script-container",
"release-id": {
"version": "1.0",
"group-id": "com.redhat",
"artifact-id": "Project1"
}
}
}
},
{
"call-container": {
"payload": "{\n \"commands\" : [ {\n \"fire-all-rules\" : {\n \"max\" : -1,\n \"out-identifier\" : null\n }\n } ]\n}",
"container-id": "command-script-container"
}
},
{
"dispose-container": {
"container-id": "command-script-container"
}
}
]
}Example HTTP response
Response 200
{
"response": [
{
"type": "SUCCESS",
"msg": "Container command-script-container successfully deployed with module com.redhat:Project1:1.0.",
"result": {
"kie-container": {
"container-id": "command-script-container",
"release-id": {
"group-id": "com.redhat",
"artifact-id": "Project1",
"version": "1.0"
},
"resolved-release-id": {
"group-id": "com.redhat",
"artifact-id": "Project1",
"version": "1.0"
},
"status": "DISPOSING",
"scanner": {
"status": "DISPOSED",
"poll-interval": null
},
"config-items": [],
"messages": [
{
"severity": "INFO",
"timestamp": {
"java.util.Date": 1538768011150
},
"content": [
"Container command-script-container successfully created with module com.redhat:Project1:1.0."
]
}
],
"container-alias": null
}
}
},
{
"type": "SUCCESS",
"msg": "Container command-script-container successfully called.",
"result": "{\n \"results\" : [ ],\n \"facts\" : [ ]\n}"
},
{
"type": "SUCCESS",
"msg": "Container command-script-container successfully disposed.",
"result": null
}
]
}Returns a list of KIE containers on the KIE Server.
GET /server/containers
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
artifactId |
optional artifactId to filter containers by |
string |
Query |
groupId |
optional groupId to filter containers by |
string |
Query |
status |
optional status to filter containers by |
string |
Query |
version |
optional version to filter containers by |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers
Example HTTP response
Response 200
{
"response": [
{
"type": "SUCCESS",
"msg": "List of created containers",
"result": {
"kie-containers": {
"kie-container": [
{
"container-id": "MyProjectContainer",
"release-id": {
"group-id": "com.redhat",
"artifact-id": "Project1",
"version": "1.0"
},
"resolved-release-id": {
"group-id": "com.redhat",
"artifact-id": "Project1",
"version": "1.0"
},
"status": "STARTED",
"scanner": {
"status": "DISPOSED",
"poll-interval": null
},
"config-items": [
{
"itemName": "KBase",
"itemValue": "",
"itemType": "BPM"
},
{
"itemName": "KSession",
"itemValue": "",
"itemType": "BPM"
},
{
"itemName": "MergeMode",
"itemValue": "MERGE_COLLECTIONS",
"itemType": "BPM"
},
{
"itemName": "RuntimeStrategy",
"itemValue": "SINGLETON",
"itemType": "BPM"
}
],
"messages": [
{
"severity": "INFO",
"timestamp": {
"java.util.Date": 1538996205681
},
"content": [
"Container MyProjectContainer successfully created with module com.redhat:Project1:1.0."
]
}
],
"container-alias": "MyProjectContainer"
},
{
"container-id": "employe-rostering",
"release-id": {
"group-id": "employeerostering",
"artifact-id": "employeerostering",
"version": "1.0.0-SNAPSHOT"
},
"resolved-release-id": {
"group-id": "employeerostering",
"artifact-id": "employeerostering",
"version": "1.0.0-SNAPSHOT"
},
"status": "STARTED",
"scanner": {
"status": "DISPOSED",
"poll-interval": null
},
"config-items": [
{
"itemName": "KBase",
"itemValue": "",
"itemType": "BPM"
},
{
"itemName": "KSession",
"itemValue": "",
"itemType": "BPM"
},
{
"itemName": "MergeMode",
"itemValue": "MERGE_COLLECTIONS",
"itemType": "BPM"
},
{
"itemName": "RuntimeStrategy",
"itemValue": "SINGLETON",
"itemType": "BPM"
}
],
"messages": [
{
"severity": "INFO",
"timestamp": {
"java.util.Date": 1539029260330
},
"content": [
"Container employee-rostering successfully created with module employeerostering:employeerostering:1.0.0-SNAPSHOT."
]
}
],
"container-alias": "employeerostering"
}
]
}
}
}
]
}Returns information about a specified KIE container.
GET /server/containers/{containerId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
Container id to be retrieved |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT
Example HTTP response
Response 200
{
"response": [
{
"type": "SUCCESS",
"msg": "Info for container MyProjectContainer",
"result": {
"kie-containers": {
"kie-container": [
{
"container-id": "MyProjectContainer",
"release-id": {
"group-id": "com.redhat",
"artifact-id": "Project1",
"version": "1.0"
},
"resolved-release-id": {
"group-id": "com.redhat",
"artifact-id": "Project1",
"version": "1.0"
},
"status": "STARTED",
"scanner": {
"status": "DISPOSED",
"poll-interval": null
},
"config-items": [
{
"itemName": "KBase",
"itemValue": "",
"itemType": "BPM"
},
{
"itemName": "KSession",
"itemValue": "",
"itemType": "BPM"
},
{
"itemName": "MergeMode",
"itemValue": "MERGE_COLLECTIONS",
"itemType": "BPM"
},
{
"itemName": "RuntimeStrategy",
"itemValue": "SINGLETON",
"itemType": "BPM"
}
],
"messages": [
{
"severity": "INFO",
"timestamp": {
"java.util.Date": 1538996205681
},
"content": [
"Container MyProjectContainer successfully created with module com.redhat:Project1:1.0."
]
}
],
"container-alias": "MyProjectContainer"
}
]
}
}
}
]
}Creates a new KIE container in the KIE Server with a specified KIE container ID
PUT /server/containers/{containerId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
Container id to be assigned to deployed KIE Container |
string |
Body |
body |
KIE Container resource to be deployed as KieContainerResource |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Successfull response |
No Content |
400 |
container could not be created |
No Content |
500 |
Unexpected error |
No Content |
Consumes
-
application/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT
Request body
{
"container-id" : "baz",
"release-id" : {
"group-id" : "foo",
"artifact-id" : "bar",
"version" : "1.0"
}
}<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<kie-container container-id="baz">
<release-id>
<group-id>foo</group-id>
<artifact-id>bar</artifact-id>
<version>1.0</version>
</release-id>
</kie-container>Example HTTP response
Response 201
{
"response": [
{
"type": "SUCCESS",
"msg": "Container MyProjectContainer successfully deployed with module com.redhat:Project1:1.0.",
"result": {
"kie-container": {
"container-id": "MyProjectContainer",
"release-id": {
"artifact-id": "Project1",
"group-id": "com.redhat",
"version": "1.0"
},
"resolved-release-id": {
"artifact-id": "Project1",
"group-id": "com.redhat",
"version": "1.0"
},
"status": "STARTED",
"scanner": {
"status": "DISPOSED",
"poll-interval": null
},
"config-items": [
],
"messages": [
{
"severity": "INFO",
"timestamp": {
"java.util.Date": 1538756503852
},
"content": [
"Container MyProjectContainer successfully created with module com.redhat:Project1:1.0."
]
}
],
"container-alias": null
}
}
}
]
}Disposes a specified KIE container.
DELETE /server/containers/{containerId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
Container id to be disposed (undeployed) |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT
Example HTTP response
Response 200
{
"response": [
{
"type": "SUCCESS",
"msg": "Container MyProjectContainer successfully disposed.",
"result": null
}
]
}Updates release ID information (group ID, artifact ID, version) for a specified KIE container.
POST /server/containers/{containerId}/release-id
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
containerId |
Container id that release id should be upgraded |
string |
|
Query |
resetBeforeUpdate |
Determines whether active processes are aborted (reset) before updating when the server runs in development mode |
boolean |
|
Body |
body |
Release Id to be upgraded to as ReleaseId type |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Consumes
-
application/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/release-id
Request body
{
"group-id" : "foo",
"artifact-id" : "bar",
"version" : "1.0"
}<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<release-id>
<group-id>foo</group-id>
<artifact-id>bar</artifact-id>
<version>1.0</version>
</release-id>Example HTTP response
Response 200
{
"response": [
{
"-type": "SUCCESS",
"-msg": "Release id successfully updated.",
"release-id": {
"artifact-id": "Project1",
"group-id": "com.redhat",
"version": "1.1"
}
}
]
}Returns release ID information (group ID, artifact ID, version) for a specified KIE container.
GET /server/containers/{containerId}/release-id
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
Container id that release id should be loaded from |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/release-id
Example HTTP response
Response 200
{
"response": [
{
"type": "SUCCESS",
"msg": "ReleaseId for container MyProjectContainer",
"result": {
"release-id": {
"group-id": "com.redhat",
"artifact-id": "Project1",
"version": "1.0"
}
}
}
]
}Starts or stops a KIE scanner that controls polling for updated KIE container deployments, if applicable.
POST /server/containers/{containerId}/scanner
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
Container id for scanner to be updated |
string |
Body |
body |
Scanner information given as KieScannerResource type |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Consumes
-
application/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/scanner
Request body
{
"status" : "STARTED",
"poll-interval" : "10000"
}<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<kie-scanner poll-interval="10000" status="STARTED"/>Example HTTP response
Response 200
{
"response": [
{
"type": "SUCCESS",
"msg": "Kie scanner successfully created.",
"result": {
"kie-scanner": {
"status": "STARTED",
"poll-interval": 20
}
}
}
]
}Returns information about the KIE scanner used for automatic updates in a specified KIE container, if applicable.
GET /server/containers/{containerId}/scanner
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
Container id for scanner to be loaded |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/scanner
Example HTTP response
Response 200
{
"response": [
{
"type": "SUCCESS",
"msg": "Scanner info successfully retrieved",
"result": {
"kie-scanner": {
"status": "DISPOSED",
"poll-interval": null
}
}
}
]
}Activates (previously deactivated) KIE container on this server
PUT /server/containers/{containerId}/status/activated
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
Container id of deployed KIE Container |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Successfull response |
No Content |
400 |
container could not be activated |
No Content |
500 |
Unexpected error |
No Content |
Consumes
-
application/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/status/activated
Example HTTP response
Response 201
{
"response": [
{
"type": "SUCCESS",
"msg": "Container MyProjectContainer successfully deployed with module com.redhat:Project1:1.0.",
"result": {
"kie-container": {
"container-id": "MyProjectContainer",
"release-id": {
"artifact-id": "Project1",
"group-id": "com.redhat",
"version": "1.0"
},
"resolved-release-id": {
"artifact-id": "Project1",
"group-id": "com.redhat",
"version": "1.0"
},
"status": "STARTED",
"scanner": {
"status": "DISPOSED",
"poll-interval": null
},
"config-items": [
],
"messages": [
{
"severity": "INFO",
"timestamp": {
"java.util.Date": 1538756503852
},
"content": [
"Container MyProjectContainer successfully created with module com.redhat:Project1:1.0."
]
}
],
"container-alias": null
}
}
}
]
}Deactivates (previously started) KIE container on this server
PUT /server/containers/{containerId}/status/deactivated
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
Container id of deployed KIE Container |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Successfull response |
No Content |
400 |
container could not be deactivated |
No Content |
500 |
Unexpected error |
No Content |
Consumes
-
application/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/status/deactivated
Example HTTP response
Response 201
{
"response": [
{
"type": "SUCCESS",
"msg": "Container MyProjectContainer successfully deployed with module com.redhat:Project1:1.0.",
"result": {
"kie-container": {
"container-id": "MyProjectContainer",
"release-id": {
"artifact-id": "Project1",
"group-id": "com.redhat",
"version": "1.0"
},
"resolved-release-id": {
"artifact-id": "Project1",
"group-id": "com.redhat",
"version": "1.0"
},
"status": "DEACTIVATED",
"scanner": {
"status": "DISPOSED",
"poll-interval": null
},
"config-items": [
],
"messages": [
{
"severity": "INFO",
"timestamp": {
"java.util.Date": 1538756503852
},
"content": [
"Container MyProjectContainer successfully created with module com.redhat:Project1:1.0."
]
}
],
"container-alias": null
}
}
}
]
}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 report flag to return detailed report of the check, defaults to false |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
successful operation |
< kie-message > array |
503 |
If any of the checks failed |
No Content |
Produces
-
application/json -
application/xml
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
Returns information about the current state and configurations of the KIE Server.
GET /server/state
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/state
Example HTTP response
Response 200
{
"response": [
{
"type": "SUCCESS",
"msg": "Successfully loaded server state for server id default-kieserver",
"result": {
"kie-server-state-info": {
"controller": [
"http://localhost:8080/business-central/rest/controller"
],
"config": {
"config-items": [
{
"itemName": "org.kie.server.location",
"itemValue": "http://localhost:8080/kie-server/services/rest/server",
"itemType": "java.lang.String"
},
{
"itemName": "org.kie.server.controller.user",
"itemValue": "controllerUser",
"itemType": "java.lang.String"
},
{
"itemName": "org.kie.server.controller",
"itemValue": "http://localhost:8080/business-central/rest/controller",
"itemType": "java.lang.String"
}
]
},
"containers": [
{
"container-id": "employee-rostering",
"release-id": {
"group-id": "employeerostering",
"artifact-id": "employeerostering",
"version": "1.0.0-SNAPSHOT"
},
"resolved-release-id": null,
"status": "STARTED",
"scanner": {
"status": "STOPPED",
"poll-interval": null
},
"config-items": [
{
"itemName": "KBase",
"itemValue": "",
"itemType": "BPM"
},
{
"itemName": "KSession",
"itemValue": "",
"itemType": "BPM"
},
{
"itemName": "MergeMode",
"itemValue": "MERGE_COLLECTIONS",
"itemType": "BPM"
},
{
"itemName": "RuntimeStrategy",
"itemValue": "SINGLETON",
"itemType": "BPM"
}
],
"messages": [],
"container-alias": "employeerostering"
}
]
}
}
}
]
}KIE Session Assets
Executes one or more runtime commands
POST /server/containers/instances/{containerId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
Container id where rules should be evaluated on |
string |
Body |
body |
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"
}Planning And Solvers :: BRP
Retrieves solvers from given container
GET /server/containers/{containerId}/solvers
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
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/{containerId}/solvers/{solverId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id where the solver resides |
string |
Path |
solverId |
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/{containerId}/solvers/{solverId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id where the solver config resides |
string |
Path |
solverId |
identifier of the solver to create |
string |
Body |
body |
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/{containerId}/solvers/{solverId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id where the solver resides |
string |
Path |
solverId |
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/{containerId}/solvers/{solverId}/bestsolution
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id where the solver resides |
string |
Path |
solverId |
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/{containerId}/solvers/{solverId}/problemfactchanges
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id where the solver resides |
string |
Path |
solverId |
identifier of the solver |
string |
Body |
body |
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/{containerId}/solvers/{solverId}/problemfactchanges/processed
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id where the solver resides |
string |
Path |
solverId |
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
trueSolves given planning problem with given solver
POST /server/containers/{containerId}/solvers/{solverId}/state/solving
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id where the solver resides |
string |
Path |
solverId |
identifier of the solver |
string |
Body |
body |
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/{containerId}/solvers/{solverId}/state/terminating-early
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id where the solver resides |
string |
Path |
solverId |
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
Returns entity and task information for a specified process.
GET /server/containers/{containerId}/processes/definitions/{processId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id where the process definition resides |
string |
Path |
processId |
process id that the definition should be retrieved for |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Process or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/processes/definitions/evaluation
Example HTTP response
Response 200
{
"associatedEntities": {
"Qualify": [
"approver"
],
"Final Approval": [
"manager"
],
"Correct Data": [
"broker"
],
"Increase Down Payment": [
"broker"
]
},
"serviceTasks": {},
"processVariables": {
"inlimit": "Boolean",
"application": "com.myspace.mortgage_app.Application",
"incdownpayment": "Boolean"
},
"reusableSubProcesses": [],
"process-id": "Mortgage_Process.MortgageApprovalProcess",
"process-name": "MortgageApprovalProcess",
"process-version": "1.0",
"package": "com.myspace.mortgage_app",
"container-id": "mortgage-process_1.0.0-SNAPSHOT",
"dynamic": false
}Retrieves actors and groups that are involved in given process and container
GET /server/containers/{containerId}/processes/definitions/{processId}/entities
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id where the process definition resides |
string |
Path |
processId |
process id that the involved actors and groups should be retrieved from |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Process or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/processes/definitions/evaluation/entities
Example HTTP response
Response 200
{
"associatedEntities": {
"Qualify": [
"approver"
],
"Final Approval": [
"manager"
],
"Correct Data": [
"broker"
],
"Increase Down Payment": [
"broker"
]
}
}Retrieves sub process definitions that are defined in given process within given container
GET /server/containers/{containerId}/processes/definitions/{processId}/subprocesses
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id where the process definition resides |
string |
Path |
processId |
process id that subprocesses should be retrieved from |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Process or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/processes/definitions/evaluation/subprocesses
Example HTTP response
Response 200
{
"subProcesses" : [ "evaluation" ]
}Retrieves service tasks definitions that are present in given process and container
GET /server/containers/{containerId}/processes/definitions/{processId}/tasks/service
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id where the process definition resides |
string |
Path |
processId |
process id that the service task definitions should be retrieved from |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Process or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/processes/definitions/evaluation/tasks/service
Example HTTP response
Response 200
{
"serviceTasks" : {
"Email results" : "Email"
}
}Retrieves user tasks definitions that are present in given process and container
GET /server/containers/{containerId}/processes/definitions/{processId}/tasks/users
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id where the process definition resides |
string |
Path |
processId |
process id that the user task definitions should be retrieved from |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Process or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/processes/definitions/evaluation/tasks/users
Example HTTP response
Response 200
{
"task": [
{
"associatedEntities": [
"broker"
],
"taskInputMappings": {
"application": "com.myspace.mortgage_app.Application",
"TaskName": "String",
"Skippable": "Object",
"GroupId": "Object"
},
"taskOutputMappings": {
"application": "com.myspace.mortgage_app.Application"
},
"task-id": "6",
"task-name": "Correct Data",
"task-priority": 0,
"task-comment": "",
"task-created-by": "",
"task-skippable": false,
"task-form-name": "CorrectData"
},
{
"associatedEntities": [
"approver"
],
"taskInputMappings": {
"application": "com.myspace.mortgage_app.Application",
"TaskName": "String",
"Skippable": "Object",
"GroupId": "Object"
},
"taskOutputMappings": {
"inlimit": "Boolean"
},
"task-id": "8",
"task-name": "Qualify",
"task-priority": 0,
"task-comment": "",
"task-created-by": "",
"task-skippable": false,
"task-form-name": "Qualify"
},
{
"associatedEntities": [
"manager"
],
"taskInputMappings": {
"inlimit": "Boolean",
"application": "com.myspace.mortgage_app.Application",
"TaskName": "String",
"Skippable": "Object",
"GroupId": "Object"
},
"taskOutputMappings": {},
"task-id": "10",
"task-name": "Final Approval",
"task-priority": 0,
"task-comment": "",
"task-created-by": "",
"task-skippable": false,
"task-form-name": "FinalApproval"
}
]
}Retrieves input variables defined on a given user task
GET /server/containers/{containerId}/processes/definitions/{processId}/tasks/users/{taskName}/inputs
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id where the process definition resides |
string |
Path |
processId |
process id that given task belongs to |
string |
Path |
taskName |
task name that input variable definitions should be retrieved for |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Process or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/processes/definitions/evaluation/tasks/users/Review/inputs
Example HTTP response
Response 200
{
"taskInputs": {
"inlimit": "Boolean",
"application": "com.myspace.mortgage_app.Application",
"TaskName": "String",
"Skippable": "Object",
"GroupId": "Object"
}
}Retrieves output variables defined on a given user task
GET /server/containers/{containerId}/processes/definitions/{processId}/tasks/users/{taskName}/outputs
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id where the process definition resides |
string |
Path |
processId |
process id that given task belongs to |
string |
Path |
taskName |
task name that output variable definitions should be retrieved for |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Process or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/processes/definitions/evaluation/tasks/users/Review/outputs
Example HTTP response
Response 200
{
"taskOutputs": {
"application": "com.myspace.mortgage_app.Application"
}
}Retrieves process variables definitions that are present in given process and container
GET /server/containers/{containerId}/processes/definitions/{processId}/variables
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id where the process definition resides |
string |
Path |
processId |
process id that the variable definitions should be retrieved from |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Process or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/processes/definitions/evaluation/variables
Example HTTP response
Response 200
{
"variables": {
"inlimit": "Boolean",
"application": "com.myspace.mortgage_app.Application",
"incdownpayment": "Boolean"
}
}Process And Task Forms
Returns the rendered form for a specified case definition.
GET /server/containers/{containerId}/forms/cases/{caseDefId}/content
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
caseDefId |
identifier of case definition that form should be fetched for |
string |
|
Path |
containerId |
container id that case definition belongs to |
string |
|
Query |
renderer |
optional renderer name that the form should be rendered with |
string |
|
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/evaluation_1.0.0-SNAPSHOT/forms/cases/orderhardware/content
Example HTTP response
Response 200
"string"Returns the form information for a specified process definition.
GET /server/containers/{containerId}/forms/processes/{processId}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
containerId |
container id that process definition belongs to |
string |
|
Path |
processId |
identifier of process definition that form should be fetched for |
string |
|
Query |
filter |
optional filter flag if form should be filtered or returned as is |
boolean |
|
Query |
lang |
optional language that the form should be found for |
string |
|
Query |
marshallContent |
optional marshall content flag if the content should be transformed or not, defaults to true |
boolean |
|
Query |
type |
optional type of the form, defaults to ANY so system will find the most current one |
string |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
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/evaluation_1.0.0-SNAPSHOT/forms/processes/evaluation
Example HTTP response
Response 200
{
"id": "d1e6dd47-b24c-4f93-ba25-337832926113",
"name": "evaluation-taskform.frm",
"model": {
"processName": "Evaluation",
"processId": "evaluation",
"name": "process",
"properties": [
{
"name": "employee",
"typeInfo": {
"type": "BASE",
"className": "java.lang.String",
"multiple": false
},
"metaData": {
"entries": [
{
"name": "field-readOnly",
"value": false
}
]
}
},
{
"name": "initiator",
"typeInfo": {
"type": "BASE",
"className": "java.lang.String",
"multiple": false
},
"metaData": {
"entries": [
{
"name": "field-readOnly",
"value": false
}
]
}
},
{
"name": "performance",
"typeInfo": {
"type": "BASE",
"className": "java.lang.Integer",
"multiple": false
},
"metaData": {
"entries": [
{
"name": "field-readOnly",
"value": false
}
]
}
},
{
"name": "reason",
"typeInfo": {
"type": "BASE",
"className": "java.lang.String",
"multiple": false
},
"metaData": {
"entries": [
{
"name": "field-readOnly",
"value": false
}
]
}
}
],
"formModelType": "org.kie.workbench.common.forms.jbpm.model.authoring.process.BusinessProcessFormModel"
},
"fields": [
{
"maxLength": 100,
"placeHolder": "Employee",
"id": "field_740177746345817E11",
"name": "employee",
"label": "Employee",
"required": true,
"readOnly": false,
"validateOnChange": true,
"binding": "employee",
"standaloneClassName": "java.lang.String",
"code": "TextBox",
"serializedFieldClassName": "org.kie.workbench.common.forms.fields.shared.fieldTypes.basic.textBox.definition.TextBoxFieldDefinition"
},
{
"placeHolder": "Reason",
"rows": 4,
"id": "field_282038126127015E11",
"name": "reason",
"label": "Reason",
"required": true,
"readOnly": false,
"validateOnChange": true,
"binding": "reason",
"standaloneClassName": "java.lang.String",
"code": "TextArea",
"serializedFieldClassName": "org.kie.workbench.common.forms.fields.shared.fieldTypes.basic.textArea.definition.TextAreaFieldDefinition"
}
],
"layoutTemplate": {
"version": 2,
"name": "evaluation-taskform.frm",
"style": "FLUID",
"layoutProperties": {},
"rows": [
{
"height": "12",
"layoutColumns": [
{
"span": "12",
"height": "12",
"rows": [],
"layoutComponents": [
{
"dragTypeName": "org.kie.workbench.common.forms.editor.client.editor.rendering.EditorFieldLayoutComponent",
"properties": {
"field_id": "field_740177746345817E11",
"form_id": "d1e6dd47-b24c-4f93-ba25-337832926113"
}
}
]
}
]
},
{
"height": "12",
"layoutColumns": [
{
"span": "12",
"height": "12",
"rows": [],
"layoutComponents": [
{
"dragTypeName": "org.kie.workbench.common.forms.editor.client.editor.rendering.EditorFieldLayoutComponent",
"properties": {
"field_id": "field_282038126127015E11",
"form_id": "d1e6dd47-b24c-4f93-ba25-337832926113"
}
}
]
}
]
}
]
}
}Returns the rendered form for a specified process definition
GET /server/containers/{containerId}/forms/processes/{processId}/content
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
containerId |
container id that process definition belongs to |
string |
|
Path |
processId |
identifier of process definition that form should be fetched for |
string |
|
Query |
renderer |
optional renderer name that the form should be rendered with |
string |
|
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/evaluation_1.0.0-SNAPSHOT/forms/processes/evaluation/content
Example HTTP response
Response 200
"string"Returns the form information for a specified task instance.
GET /server/containers/{containerId}/forms/tasks/{taskInstanceId}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
|
Path |
taskInstanceId |
identifier of task instance that form should be fetched for |
integer (int64) |
|
Query |
filter |
optional filter flag if form should be filtered or returned as is |
boolean |
|
Query |
lang |
optional language that the form should be found for |
string |
|
Query |
marshallContent |
optional marshall content flag if the content should be transformed or not, defaults to true |
boolean |
|
Query |
type |
optional type of the form, defaults to ANY so system will find the most current one |
string |
|
Query |
user |
optional user id to be used instead of authenticated user - only when bypass authenticated user is enabled |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
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/evaluation_1.0.0-SNAPSHOT/forms/tasks/123
Example HTTP response
Response 200
{
"id": "47078d21-7da5-4d3f-8355-0fcd78b09f39",
"name": "PerformanceEvaluation-taskform.frm",
"model": {
"taskName": "PerformanceEvaluation",
"processId": "evaluation",
"name": "task",
"properties": [
{
"name": "BusinessAdministratorId",
"typeInfo": {
"type": "BASE",
"className": "java.lang.String",
"multiple": false
},
"metaData": {
"entries": [
{
"name": "field-readOnly",
"value": true
}
]
}
},
{
"name": "reason",
"typeInfo": {
"type": "BASE",
"className": "java.lang.String",
"multiple": false
},
"metaData": {
"entries": [
{
"name": "field-readOnly",
"value": true
}
]
}
},
{
"name": "performance",
"typeInfo": {
"type": "BASE",
"className": "java.lang.Integer",
"multiple": false
},
"metaData": {
"entries": [
{
"name": "field-readOnly",
"value": false
}
]
}
}
],
"formModelType": "org.kie.workbench.common.forms.jbpm.model.authoring.task.TaskFormModel"
},
"fields": [
{
"placeHolder": "Reason",
"rows": 4,
"id": "field_332058348325587E12",
"name": "reason",
"label": "Reason",
"required": false,
"readOnly": true,
"validateOnChange": true,
"binding": "reason",
"standaloneClassName": "java.lang.String",
"code": "TextArea",
"serializedFieldClassName": "org.kie.workbench.common.forms.fields.shared.fieldTypes.basic.textArea.definition.TextAreaFieldDefinition"
},
{
"placeHolder": "Performance",
"maxLength": 100,
"id": "field_336003622256354E12",
"name": "performance",
"label": "Performance",
"required": true,
"readOnly": false,
"validateOnChange": true,
"binding": "performance",
"standaloneClassName": "java.lang.Integer",
"code": "IntegerBox",
"serializedFieldClassName": "org.kie.workbench.common.forms.fields.shared.fieldTypes.basic.integerBox.definition.IntegerBoxFieldDefinition"
}
],
"layoutTemplate": {
"version": 2,
"name": "PerformanceEvaluation-taskform.frm",
"style": "FLUID",
"layoutProperties": {},
"rows": [
{
"height": "12",
"layoutColumns": [
{
"span": "12",
"height": "12",
"rows": [],
"layoutComponents": [
{
"dragTypeName": "org.kie.workbench.common.forms.editor.client.editor.rendering.EditorFieldLayoutComponent",
"properties": {
"field_id": "field_332058348325587E12",
"form_id": "47078d21-7da5-4d3f-8355-0fcd78b09f39"
}
}
]
}
]
},
{
"height": "12",
"layoutColumns": [
{
"span": "12",
"height": "12",
"rows": [],
"layoutComponents": [
{
"dragTypeName": "org.kie.workbench.common.forms.editor.client.editor.rendering.EditorFieldLayoutComponent",
"properties": {
"field_id": "field_336003622256354E12",
"form_id": "47078d21-7da5-4d3f-8355-0fcd78b09f39"
}
}
]
}
]
}
]
}
}Returns the rendered form for a specified task instance.
GET /server/containers/{containerId}/forms/tasks/{taskInstanceId}/content
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
|
Path |
taskInstanceId |
identifier of task instance that form should be fetched for |
integer (int64) |
|
Query |
renderer |
optional renderer name that the form should be rendered with |
string |
|
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/evaluation_1.0.0-SNAPSHOT/forms/tasks/123/content
Example HTTP response
Response 200
"string"Process Images
Returns an annotated SVG image file of a specified process instance diagram.
GET /server/containers/{containerId}/images/processes/instances/{processInstanceId}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
containerId |
container id that process instance belongs to |
string |
|
Path |
processInstanceId |
identifier of the process instance that image should be loaded for |
integer (int64) |
|
Query |
svgActiveBorderColor |
svg active node border color |
string |
|
Query |
svgCompletedBorderColor |
svg completed node border color |
string |
|
Query |
svgCompletedColor |
svg completed node color |
string |
|
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/evaluation_1.0.0-SNAPSHOT/images/processes/instances/123
Example HTTP response
Response 200
"string"Returns an SVG image file of a specified process definition diagram.
GET /server/containers/{containerId}/images/processes/{processId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that process definition belongs to |
string |
Path |
processId |
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/evaluation_1.0.0-SNAPSHOT/images/processes/evaluation
Example HTTP response
Response 200
"string"Process Instance Administration
Returns all process execution errors for a specified KIE container.
GET /server/admin/containers/{containerId}/processes/errors
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
containerId |
container id that errors belong to |
string |
|
Query |
includeAck |
optional flag that indicates if acknowledged errors should also be collected, defaults to false |
boolean |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Query |
sort |
optional sort column, no default |
string |
|
Query |
sortOrder |
optional sort direction (asc, desc) - defaults to asc |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Process instance or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/admin/containers/evaluation_1.0.0-SNAPSHOT/processes/errors
Example HTTP response
Response 200
{
"error-instance": [
{
"id": "54b04160-6242-475d-9452-0df3678123b0",
"type": "Process",
"container-id": "mortgage-process_1.0.0-SNAPSHOT",
"process-instance-id": 4,
"process-id": "Mortgage_Process.MortgageApprovalProcess",
"activity-id": 12,
"activity-name": "Validation",
"job-id": null,
"error-msg": "[Mortgage_Process.MortgageApprovalProcess:4 - Validation:3] -- [Mortgage_Process.MortgageApprovalProcess:4 - Validation:3] -- null",
"error": null,
"acknowledged": false,
"acknowledged-by": null,
"acknowledged-at": null,
"error-date": 1539627373788
},
{
"id": "a7982044-019d-4d4a-be3f-781f4ddca1df",
"type": "Process",
"container-id": "mortgage-process_1.0.0-SNAPSHOT",
"process-instance-id": 4,
"process-id": "Mortgage_Process.MortgageApprovalProcess",
"activity-id": 12,
"activity-name": "Validation",
"job-id": null,
"error-msg": "[Mortgage_Process.MortgageApprovalProcess:4 - Validation:3] -- [Mortgage_Process.MortgageApprovalProcess:4 - Validation:3] -- null",
"error": null,
"acknowledged": false,
"acknowledged-by": null,
"acknowledged-at": null,
"error-date": 1539627364193
}
]
}Acknowledges multiple process execution errors (sets acknowledged to true for the errors).
PUT /server/admin/containers/{containerId}/processes/errors
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that errors belong to |
string |
Query |
errorId |
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/json -
application/xml
Example HTTP request
Request path
/server/admin/containers/evaluation_1.0.0-SNAPSHOT/processes/errors?errorId=xxx-yyy-zzz
Returns information about a specified process execution error.
GET /server/admin/containers/{containerId}/processes/errors/{errorId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that process error belongs to |
string |
Path |
errorId |
identifier of error to be loaded |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Process instance or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/admin/containers/evaluation_1.0.0-SNAPSHOT/processes/errors/xxx-yyy-zzz
Example HTTP response
Response 200
{
"id": "a7982044-019d-4d4a-be3f-781f4ddca1df",
"type": "Process",
"container-id": "mortgage-process_1.0.0-SNAPSHOT",
"process-instance-id": 4,
"process-id": "Mortgage_Process.MortgageApprovalProcess",
"activity-id": 12,
"activity-name": "Validation",
"job-id": null,
"error-msg": "[Mortgage_Process.MortgageApprovalProcess:4 - Validation:3] -- [Mortgage_Process.MortgageApprovalProcess:4 - Validation:3] -- null",
"error": null,
"acknowledged": false,
"acknowledged-by": null,
"acknowledged-at": null,
"error-date": 1539627364193
}Acknowledges a specified process execution error (sets acknowledged to true for the error).
PUT /server/admin/containers/{containerId}/processes/errors/{errorId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that error belongs to |
string |
Path |
errorId |
identifier of error to be acknowledged |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
404 |
Execution error or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/admin/containers/evaluation_1.0.0-SNAPSHOT/processes/errors/xxx-yyy-zzz
Migrates multiple process instances to process definition in another KIE container.
PUT /server/admin/containers/{containerId}/processes/instances
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that process instances belongs to |
string |
Query |
processInstanceId |
list of identifiers of process instance to be migrated |
< integer (int64) > array(multi) |
Query |
targetContainerId |
container id that new process definition belongs to |
string |
Query |
targetProcessId |
process definition that process instances should be migrated to |
string |
Body |
body |
node mapping - unique ids of old definition to new definition given as Map |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Successfull response |
No Content |
404 |
Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Consumes
-
application/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/admin/containers/evaluation_1.0.0-SNAPSHOT/processes/instances?processInstanceId=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": "2018-10-15T15:12:47.194Z",
"migration-end": "2018-10-15T15:13:17.202Z",
"migration-logs": [
"15-Oct-2018 15:56:23: StartNode () - Human\n15-Oct-2018 15:56:23: Join () - System\n15-Oct-2018 15:56:23: RuleSetNode (Validation) - System\n15-Oct-2018 15:56:23: Split () - System\n15-Oct-2018 15:56:23: RuleSetNode (Retract Validation) - System\n15-Oct-2018 15:56:23: HumanTaskNode (Correct Data) - System\n15-Oct-2018 15:56:23: RuleSetNode (Retract Validation) Completed - System\n15-Oct-2018 15:56:23: Split () Completed - System\n15-Oct-2018 15:56:23: RuleSetNode (Validation) Completed - System\n15-Oct-2018 15:56:23: Join () Completed - System\n15-Oct-2018 15:56:23: StartNode () Completed - System"
],
"migration-process-instance": 5
},
{
"migration-successful": true,
"migration-start": "2018-10-15T15:13:17.202Z",
"migration-end": "2018-10-15T15:13:47.194Z",
"migration-logs": [
"15-Oct-2018 15:56:23: StartNode () - Human\n15-Oct-2018 15:56:23: Join () - System\n15-Oct-2018 15:56:23: RuleSetNode (Validation) - System\n15-Oct-2018 15:56:23: Split () - System\n15-Oct-2018 15:56:23: RuleSetNode (Retract Validation) - System\n15-Oct-2018 15:56:23: HumanTaskNode (Correct Data) - System\n15-Oct-2018 15:56:23: RuleSetNode (Retract Validation) Completed - System\n15-Oct-2018 15:56:23: Split () Completed - System\n15-Oct-2018 15:56:23: RuleSetNode (Validation) Completed - System\n15-Oct-2018 15:56:23: Join () Completed - System\n15-Oct-2018 15:56:23: StartNode () Completed - System"
],
"migration-process-instance": 6
}
]
}Migrates a specified process instance to a process definition in another KIE container.
PUT /server/admin/containers/{containerId}/processes/instances/{processInstanceId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that process instance belongs to |
string |
Path |
processInstanceId |
identifier of process instance to be migrated |
integer (int64) |
Query |
targetContainerId |
container id that new process definition belongs to |
string |
Query |
targetProcessId |
process definition that process instance should be migrated to |
string |
Body |
body |
node mapping - unique ids of old definition to new definition given as Map |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Successfull response |
No Content |
404 |
Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Consumes
-
application/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/admin/containers/evaluation_1.0.0-SNAPSHOT/processes/instances/123?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": "2018-10-15T15:12:47.194Z",
"migration-end": "2018-10-15T15:12:47.194Z",
"migration-logs": [
"15-Oct-2018 15:56:23: StartNode () - Human\n15-Oct-2018 15:56:23: Join () - System\n15-Oct-2018 15:56:23: RuleSetNode (Validation) - System\n15-Oct-2018 15:56:23: Split () - System\n15-Oct-2018 15:56:23: RuleSetNode (Retract Validation) - System\n15-Oct-2018 15:56:23: HumanTaskNode (Correct Data) - System\n15-Oct-2018 15:56:23: RuleSetNode (Retract Validation) Completed - System\n15-Oct-2018 15:56:23: Split () Completed - System\n15-Oct-2018 15:56:23: RuleSetNode (Validation) Completed - System\n15-Oct-2018 15:56:23: Join () Completed - System\n15-Oct-2018 15:56:23: StartNode () Completed - System"
],
"migration-process-instance": 4
}Returns all process execution errors for a specified process instance.
GET /server/admin/containers/{containerId}/processes/instances/{processInstanceId}/errors
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
containerId |
container id that process instance belongs to |
string |
|
Path |
processInstanceId |
identifier of process instance that errors should be collected for |
integer (int64) |
|
Query |
includeAck |
optional flag that indicates if acknowledged errors should also be collected, defaults to false |
boolean |
|
Query |
node |
optional name of the node in the process instance to filter by |
string |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Query |
sort |
optional sort column, no default |
string |
|
Query |
sortOrder |
optional sort direction (asc, desc) - defaults to asc |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/admin/containers/evaluation_1.0.0-SNAPSHOT/processes/instances/123/errors
Example HTTP response
Response 200
{
"error-instance": [
{
"id": "54b04160-6242-475d-9452-0df3678123b0",
"type": "Process",
"container-id": "mortgage-process_1.0.0-SNAPSHOT",
"process-instance-id": 4,
"process-id": "Mortgage_Process.MortgageApprovalProcess",
"activity-id": 12,
"activity-name": "Validation",
"job-id": null,
"error-msg": "[Mortgage_Process.MortgageApprovalProcess:4 - Validation:3] -- [Mortgage_Process.MortgageApprovalProcess:4 - Validation:3] -- null",
"error": null,
"acknowledged": false,
"acknowledged-by": null,
"acknowledged-at": null,
"error-date": 1539627373788
},
{
"id": "a7982044-019d-4d4a-be3f-781f4ddca1df",
"type": "Process",
"container-id": "mortgage-process_1.0.0-SNAPSHOT",
"process-instance-id": 4,
"process-id": "Mortgage_Process.MortgageApprovalProcess",
"activity-id": 12,
"activity-name": "Validation",
"job-id": null,
"error-msg": "[Mortgage_Process.MortgageApprovalProcess:4 - Validation:3] -- [Mortgage_Process.MortgageApprovalProcess:4 - Validation:3] -- null",
"error": null,
"acknowledged": false,
"acknowledged-by": null,
"acknowledged-at": null,
"error-date": 1539627364193
}
]
}Returns all the active node instances in a specified process instance.
GET /server/admin/containers/{containerId}/processes/instances/{processInstanceId}/nodeinstances
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that process instance belongs to |
string |
Path |
processInstanceId |
identifier of process instance that active nodes instances should be collected for |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Process instance or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/admin/containers/evaluation_1.0.0-SNAPSHOT/processes/instances/123/nodeinstances
Example HTTP response
Response 200
{
"node-instance": [
{
"node-instance-id": 1,
"node-name": "Task",
"process-instance-id": 2,
"work-item-id": 2,
"container-id": "employee-rostering",
"start-date": {
"java.util.Date": 1539184095048
},
"node-id": "_5F8EED98-433C-4E7B-97BC-0E70615F13CB",
"node-type": "HumanTaskNode",
"node-connection": "_E89FEB0F-B8E1-4138-9DF0-397C9F9A6512",
"node-completed": false,
"reference-id": null,
"sla-compliance": 0,
"sla-due-date": null
}
]
}Re-triggers a specified node instance for a specified process instance. If the node is not active in the process instance, it becomes active upon re-triggering.
PUT /server/admin/containers/{containerId}/processes/instances/{processInstanceId}/nodeinstances/{nodeInstanceId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that process instance belongs to |
string |
Path |
nodeInstanceId |
identifier of node instance that should be retriggered |
integer (int64) |
Path |
processInstanceId |
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/json -
application/xml
Example HTTP request
Request path
/server/admin/containers/evaluation_1.0.0-SNAPSHOT/processes/instances/123/nodeinstances/567
Aborts a specified node instance within a specified process instance.
DELETE /server/admin/containers/{containerId}/processes/instances/{processInstanceId}/nodeinstances/{nodeInstanceId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that process instance belongs to |
string |
Path |
nodeInstanceId |
identifier of node instance that should be canceled |
integer (int64) |
Path |
processInstanceId |
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/json -
application/xml
Example HTTP request
Request path
/server/admin/containers/evaluation_1.0.0-SNAPSHOT/processes/instances/123/nodeinstances/567
Returns all nodes in a specified process instance.
GET /server/admin/containers/{containerId}/processes/instances/{processInstanceId}/nodes
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that process instance belongs to |
string |
Path |
processInstanceId |
identifier of process instance that process nodes should be collected from |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Process instance or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/admin/containers/evaluation_1.0.0-SNAPSHOT/processes/instances/123/nodes
Example HTTP response
Response 200
{
"process-node": [
{
"name": "",
"id": 1,
"type": "StartNode",
"process-id": "Mortgage_Process.MortgageApprovalProcess"
},
{
"name": "",
"id": 2,
"type": "Join",
"process-id": "Mortgage_Process.MortgageApprovalProcess"
},
{
"name": "Validation",
"id": 3,
"type": "RuleSetNode",
"process-id": "Mortgage_Process.MortgageApprovalProcess"
},
{
"name": "",
"id": 4,
"type": "Split",
"process-id": "Mortgage_Process.MortgageApprovalProcess"
},
{
"name": "Retract Validation",
"id": 5,
"type": "RuleSetNode",
"process-id": "Mortgage_Process.MortgageApprovalProcess"
},
{
"name": "Correct Data",
"id": 6,
"type": "HumanTaskNode",
"process-id": "Mortgage_Process.MortgageApprovalProcess"
},
{
"name": "Mortgage Calculation",
"id": 7,
"type": "RuleSetNode",
"process-id": "Mortgage_Process.MortgageApprovalProcess"
},
{
"name": "Qualify",
"id": 8,
"type": "HumanTaskNode",
"process-id": "Mortgage_Process.MortgageApprovalProcess"
},
{
"name": "",
"id": 9,
"type": "Split",
"process-id": "Mortgage_Process.MortgageApprovalProcess"
},
{
"name": "Final Approval",
"id": 10,
"type": "HumanTaskNode",
"process-id": "Mortgage_Process.MortgageApprovalProcess"
},
{
"name": "",
"id": 11,
"type": "EndNode",
"process-id": "Mortgage_Process.MortgageApprovalProcess"
},
{
"name": "Increase Down Payment",
"id": 12,
"type": "HumanTaskNode",
"process-id": "Mortgage_Process.MortgageApprovalProcess"
},
{
"name": "",
"id": 13,
"type": "Split",
"process-id": "Mortgage_Process.MortgageApprovalProcess"
},
{
"name": "",
"id": 14,
"type": "EndNode",
"process-id": "Mortgage_Process.MortgageApprovalProcess"
}
]
}Triggers a specified node for a specified process instance. If the node is not active in the process instance, it becomes active upon triggering.
POST /server/admin/containers/{containerId}/processes/instances/{processInstanceId}/nodes/{nodeId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that process instance belongs to |
string |
Path |
nodeId |
identifier of the node to be triggered |
integer (int64) |
Path |
processInstanceId |
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/json -
application/xml
Example HTTP request
Request path
/server/admin/containers/evaluation_1.0.0-SNAPSHOT/processes/instances/123/nodes/567
Returns all timers for a specified process instance.
GET /server/admin/containers/{containerId}/processes/instances/{processInstanceId}/timers
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that process instance belongs to |
string |
Path |
processInstanceId |
identifier of process instance that timer instances should be collected for |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/admin/containers/evaluation_1.0.0-SNAPSHOT/processes/instances/123/timers
Example HTTP response
Response 200
{
"timer-instance": [
{
"name": "MyTimer",
"id": 1,
"activation-time": "2018-10-18T04:49:28.907Z",
"last-fire-time": "2018-10-18T04:49:28.907Z",
"next-fire-time": "2018-10-18T04:49:28.907Z",
"delay": 35000,
"period": 500000,
"repeat-limit": 2,
"process-instance-id": 6,
"session-id": 9
}
]
}Updates a specified timer for a specified process instance.
PUT /server/admin/containers/{containerId}/processes/instances/{processInstanceId}/timers/{timerId}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
containerId |
container id that process instance belongs to |
string |
|
Path |
processInstanceId |
identifier of process instance that timer belongs to |
integer (int64) |
|
Path |
timerId |
identifier of timer instance to be updated |
integer (int64) |
|
Query |
relative |
optional flag that indicates if the time expression is relative to the current date or not, defaults to true |
boolean |
|
Body |
body |
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/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/admin/containers/evaluation_1.0.0-SNAPSHOT/processes/instances/123/timers/99
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>Process Instances
Returns a list of process definitions in a specified KIE container.
GET /server/containers/{containerId}/processes
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
containerId |
container id that process instance belongs to |
string |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Query |
sort |
optional sort column, no default |
string |
|
Query |
sortOrder |
optional sort direction (asc, desc) - defaults to asc |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/processes
Example HTTP response
Response 200
{
"processes": [
{
"associatedEntities": null,
"serviceTasks": null,
"processVariables": null,
"reusableSubProcesses": null,
"process-id": "Employee_Rostering.Process1",
"process-name": "Process1",
"process-version": "1.0",
"package": "employeerostering.employeerostering",
"container-id": "employee-rostering",
"dynamic": false
}
]
}Returns a list of process instances in a specified KIE container.
GET /server/containers/{containerId}/processes/instances
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
containerId |
container id that process instance belongs to |
string |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Query |
sort |
optional sort column, no default |
string |
|
Query |
sortOrder |
optional sort direction (asc, desc) - defaults to asc |
boolean |
|
Query |
status |
optional process instance status (active, completed, aborted) - defaults ot active (1) only |
< enum (1, 2, 3) > array(multi) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/processes/instances
Example HTTP response
Response 200
{
"process-instance": [
{
"process-instance-id": 1,
"process-id": "Employee_Rostering.Process1",
"process-name": "Process1",
"process-version": "1.0",
"process-instance-state": 1,
"container-id": "employee-rostering",
"initiator": "baAdmin",
"start-date": {
"java.util.Date": 1539184095041
},
"process-instance-desc": "Process1",
"correlation-key": "1",
"parent-instance-id": -1,
"sla-compliance": 0,
"sla-due-date": null,
"active-user-tasks": null,
"process-instance-variables": null
},
{
"process-instance-id": 2,
"process-id": "Employee_Rostering.Process2",
"process-name": "Process2",
"process-version": "1.0",
"process-instance-state": 1,
"container-id": "employee-rostering",
"initiator": "baAdmin",
"start-date": {
"java.util.Date": 1539184303976
},
"process-instance-desc": "Process2",
"correlation-key": "2",
"parent-instance-id": -1,
"sla-compliance": 0,
"sla-due-date": null,
"active-user-tasks": null,
"process-instance-variables": null
}
]
}Aborts multiple specified process instances in a specified KIE container.
DELETE /server/containers/{containerId}/processes/instances
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that process instance belongs to |
string |
Query |
instanceId |
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/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/processes/instances?instanceId=0
Signals multiple process instances with a specified signal name.
POST /server/containers/{containerId}/processes/instances/signal/{signalName}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that process instance belongs to |
string |
Path |
signalName |
signal name to be send to process instance |
string |
Query |
instanceId |
list of identifiers of the process instances to be signaled |
< integer (int64) > array(multi) |
Body |
body |
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/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/processes/instances/signal/EventReceived
Request body
{
"Person": {
"name": "john"
}
}<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<person>
<name>john</name>
</person>Returns information about a specified process instance in a specified KIE container.
GET /server/containers/{containerId}/processes/instances/{processInstanceId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that process instance belongs to |
string |
Path |
processInstanceId |
identifier of the process instance to be fetched |
integer (int64) |
Query |
withVars |
indicates if process instance variables should be loaded or not |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Process instance or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/processes/instances/123
Example HTTP response
Response 200
{
"process-instance-id": 1,
"process-id": "Employee_Rostering.Process1",
"process-name": "Process1",
"process-version": "1.0",
"process-instance-state": 1,
"container-id": "employee-rostering",
"initiator": "baAdmin",
"start-date": {
"java.util.Date": 1539184095041
},
"process-instance-desc": "Process1",
"correlation-key": "1",
"parent-instance-id": -1,
"sla-compliance": 0,
"sla-due-date": null,
"active-user-tasks": null,
"process-instance-variables": {
"initiator": "baAdmin"
}
}Aborts a specified process instance in a specified KIE container.
DELETE /server/containers/{containerId}/processes/instances/{processInstanceId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that process instance belongs to |
string |
Path |
processInstanceId |
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/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/processes/instances/123
Returns node instances for the specified process instance.
GET /server/containers/{containerId}/processes/instances/{processInstanceId}/nodes/instances
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
containerId |
container id that process instance belongs to |
string |
|
Path |
processInstanceId |
identifier of the process instance that history should be collected for |
integer (int64) |
|
Query |
activeOnly |
instructs if active nodes only should be collected, defaults to false |
boolean |
|
Query |
completedOnly |
instructs if completed nodes only should be collected, defaults to false |
boolean |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Process Instance or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/processes/instances/123/nodes/instances
Example HTTP response
Response 200
{
"node-instance": [
{
"node-instance-id": 1,
"node-name": "Task",
"process-instance-id": 2,
"work-item-id": 2,
"container-id": "employee-rostering",
"start-date": {
"java.util.Date": 1539184095048
},
"node-id": "_5F8EED98-433C-4E7B-97BC-0E70615F13CB",
"node-type": "HumanTaskNode",
"node-connection": "_E89FEB0F-B8E1-4138-9DF0-397C9F9A6512",
"node-completed": false,
"reference-id": null,
"sla-compliance": 0,
"sla-due-date": null
}
]
}Returns a list of process instances for which a specified process instance is a parent process instance
GET /server/containers/{containerId}/processes/instances/{processInstanceId}/processes
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
containerId |
container id that process instance belongs to |
string |
|
Path |
processInstanceId |
identifier of the parent process instance that process instances should be collected for |
integer (int64) |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Query |
sort |
optional sort column, no default |
string |
|
Query |
sortOrder |
optional sort direction (asc, desc) - defaults to asc |
boolean |
|
Query |
status |
optional process instance status (active, completed, aborted) - defaults ot active (1) only |
< enum (1, 2, 3) > array(multi) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/processes/instances/123/processes
Example HTTP response
Response 200
{
"process-instance": [
{
"process-instance-id": 1,
"process-id": "Employee_Rostering.Process1",
"process-name": "Process1",
"process-version": "1.0",
"process-instance-state": 1,
"container-id": "employee-rostering",
"initiator": "baAdmin",
"start-date": {
"java.util.Date": 1539184095041
},
"process-instance-desc": "Process1",
"correlation-key": "1",
"parent-instance-id": -1,
"sla-compliance": 0,
"sla-due-date": null,
"active-user-tasks": null,
"process-instance-variables": null
},
{
"process-instance-id": 2,
"process-id": "Employee_Rostering.Process2",
"process-name": "Process2",
"process-version": "1.0",
"process-instance-state": 1,
"container-id": "employee-rostering",
"initiator": "baAdmin",
"start-date": {
"java.util.Date": 1539184303976
},
"process-instance-desc": "Process2",
"correlation-key": "2",
"parent-instance-id": -1,
"sla-compliance": 0,
"sla-due-date": null,
"active-user-tasks": null,
"process-instance-variables": null
}
]
}Signals a specified process instance with a specified signal name and optional signal data.
POST /server/containers/{containerId}/processes/instances/{processInstanceId}/signal/{signalName}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that process instance belongs to |
string |
Path |
processInstanceId |
identifier of the process instance to be signaled |
integer (int64) |
Path |
signalName |
signal name to be send to process instance |
string |
Body |
body |
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/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/processes/instances/123/signal/EventReceived
Request body
{
"Person": {
"name": "john"
}
}<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<person>
<name>john</name>
</person>Returns all available signal names for a specified process instance.
GET /server/containers/{containerId}/processes/instances/{processInstanceId}/signals
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that process instance belongs to |
string |
Path |
processInstanceId |
identifier of the process instance that signals should be collected for |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Process instance or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/processes/instances/123/signals
Example HTTP response
Response 200
[ "wait", "another"]Returns the value of a specified variable in a specified process instance.
GET /server/containers/{containerId}/processes/instances/{processInstanceId}/variable/{varName}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that process instance belongs to |
string |
Path |
processInstanceId |
identifier of the process instance that variable should be retrieved from |
integer (int64) |
Path |
varName |
variable name to be retrieved |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Process instance or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/processes/instances/123/variable/person
Example HTTP response
Response 200
{
"com.myspace.mortgage_app.Application": {
"applicant": {
"com.myspace.mortgage_app.Applicant": {
"name": "",
"annualincome": 0,
"address": null,
"ssn": 0,
"creditrating": null
}
},
"property": {
"com.myspace.mortgage_app.Property": {
"age": 0,
"address": "",
"locale": "",
"saleprice": 0
}
},
"downpayment": 0,
"amortization": 0,
"mortgageamount": null
}
}Creates or updates a variable for a specified process instance.
PUT /server/containers/{containerId}/processes/instances/{processInstanceId}/variable/{varName}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that process instance belongs to |
string |
Path |
processInstanceId |
identifier of the process instance to be updated |
integer (int64) |
Path |
varName |
name of the variable to be set/updated |
string |
Body |
body |
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/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/processes/instances/123/variable/name
Request body
{
"Person": {
"name": "john"
}
}<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<person>
<name>john</name>
</person>Updates the values of one or more variable for a specified process instance. The request is a map in which the key is the variable name and the value is the new variable value.
POST /server/containers/{containerId}/processes/instances/{processInstanceId}/variables
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that process instance belongs to |
string |
Path |
processInstanceId |
identifier of the process instance to be updated |
integer (int64) |
Body |
body |
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/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/processes/instances/123/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 all variables for a specified process instance as a map in which the key is the variable name and the value is the variable value.
GET /server/containers/{containerId}/processes/instances/{processInstanceId}/variables
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that process instance belongs to |
string |
Path |
processInstanceId |
identifier of the process instance that variables should be retrieved from |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Process instance or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/processes/instances/123/variables
Example HTTP response
Response 200
{
"application": {
"com.myspace.mortgage_app.Application": {
"applicant": {
"com.myspace.mortgage_app.Applicant": {
"name": "",
"annualincome": 0,
"address": null,
"ssn": 0,
"creditrating": null
}
},
"property": {
"com.myspace.mortgage_app.Property": {
"age": 0,
"address": "",
"locale": "",
"saleprice": 0
}
},
"downpayment": 0,
"amortization": 0,
"mortgageamount": null
}
},
"initiator": "baAdmin"
}Returns the current variable values of a specified process instance in a specified KIE container.
GET /server/containers/{containerId}/processes/instances/{processInstanceId}/variables/instances
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that process instance belongs to |
string |
Path |
processInstanceId |
identifier of the process instance that variables state should be collected for |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Process Instance or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/processes/instances/123/variables/instances
Example HTTP response
Response 200
{
"variable-instance": [
{
"name": "initiator",
"old-value": "",
"value": "baAdmin",
"process-instance-id": 2,
"modification-date": {
"java.util.Date": 1539610491992
}
},
{
"name": "application",
"old-value": "com.myspace.mortgage_app.Application@bd449b3",
"value": "com.myspace.mortgage_app.Application@bd449b3",
"process-instance-id": 2,
"modification-date": {
"java.util.Date": 1539610492006
}
}
]
}Returns the history of a specified variable in a specified process instance.
GET /server/containers/{containerId}/processes/instances/{processInstanceId}/variables/instances/{varName}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
containerId |
container id that process instance belongs to |
string |
|
Path |
processInstanceId |
identifier of the process instance that variable history should be collected for |
integer (int64) |
|
Path |
varName |
name of the variables that history should be collected for |
string |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Process Instance or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/processes/instances/123/variables/instances/person
Example HTTP response
Response 200
{
"variable-instance": [
{
"name": "initiator",
"old-value": "",
"value": "baAdmin",
"process-instance-id": 2,
"modification-date": {
"java.util.Date": 1539610491992
}
},
{
"name": "application",
"old-value": "com.myspace.mortgage_app.Application@bd449b3",
"value": "com.myspace.mortgage_app.Application@bd449b3",
"process-instance-id": 2,
"modification-date": {
"java.util.Date": 1539610492006
}
}
]
}Returns all work items for a specified process instance.
GET /server/containers/{containerId}/processes/instances/{processInstanceId}/workitems
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that process instance belongs to |
string |
Path |
processInstanceId |
identifier of the process instance that work items belong to |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Process instance, Work Item or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/processes/instances/123/workitems
Example HTTP response
Response 200
{
"work-item-instance": [
{
"work-item-id": 4,
"work-item-name": "Human Task",
"work-item-state": 0,
"work-item-params": {
"application": {
"com.myspace.mortgage_app.Application": {
"applicant": {
"com.myspace.mortgage_app.Applicant": {
"name": "NewName",
"annualincome": 0,
"address": null,
"ssn": 0,
"creditrating": null
}
},
"property": {
"com.myspace.mortgage_app.Property": {
"age": 0,
"address": "NewAddress",
"locale": "",
"saleprice": 0
}
},
"downpayment": 0,
"amortization": 0,
"mortgageamount": null
}
},
"TaskName": "CorrectData",
"NodeName": "Correct Data",
"Skippable": "false",
"GroupId": "broker"
},
"process-instance-id": 4,
"container-id": "mortgage-process_1.0.0-SNAPSHOT",
"node-instance-id": 5,
"node-id": 6
}
]
}Returns information about a specified work item for a specified process instance.
GET /server/containers/{containerId}/processes/instances/{processInstanceId}/workitems/{workItemId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that process instance belongs to |
string |
Path |
processInstanceId |
identifier of the process instance that work item belongs to |
integer (int64) |
Path |
workItemId |
identifier of the work item to retrieve |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Process instance, Work Item or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/processes/instances/123/workitems/567
Example HTTP response
Response 200
{
"work-item-instance": [
{
"work-item-id": 4,
"work-item-name": "Human Task",
"work-item-state": 0,
"work-item-params": {
"application": {
"com.myspace.mortgage_app.Application": {
"applicant": {
"com.myspace.mortgage_app.Applicant": {
"name": "NewName",
"annualincome": 0,
"address": null,
"ssn": 0,
"creditrating": null
}
},
"property": {
"com.myspace.mortgage_app.Property": {
"age": 0,
"address": "NewAddress",
"locale": "",
"saleprice": 0
}
},
"downpayment": 0,
"amortization": 0,
"mortgageamount": null
}
},
"TaskName": "CorrectData",
"NodeName": "Correct Data",
"Skippable": "false",
"GroupId": "broker"
},
"process-instance-id": 4,
"container-id": "mortgage-process_1.0.0-SNAPSHOT",
"node-instance-id": 5,
"node-id": 6
}
]
}Aborts a specified work item for a specified process instance.
PUT /server/containers/{containerId}/processes/instances/{processInstanceId}/workitems/{workItemId}/aborted
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that process instance belongs to |
string |
Path |
processInstanceId |
identifier of the process instance that work item belongs to |
integer (int64) |
Path |
workItemId |
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/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/processes/instances/123/workitems/567/aborted
Completes a specified work item for a specified process instance.
PUT /server/containers/{containerId}/processes/instances/{processInstanceId}/workitems/{workItemId}/completed
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that process instance belongs to |
string |
Path |
processInstanceId |
identifier of the process instance that work item belongs to |
integer (int64) |
Path |
workItemId |
identifier of the work item to complete |
integer (int64) |
Body |
body |
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/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/processes/instances/123/workitems/567/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 a new process instance of a specified process.
POST /server/containers/{containerId}/processes/{processId}/instances
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id where the process definition resides |
string |
Path |
processId |
process id that new instance should be created from |
string |
Body |
body |
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/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/processes/evaluation/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
10<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<long-type>
<value>10</value>
</long-type>Starts a new process instance of a specified process and assigns a new correlation key to the process instance.
POST /server/containers/{containerId}/processes/{processId}/instances/correlation/{correlationKey}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id where the process definition resides |
string |
Path |
correlationKey |
correlation key to be assigned to process instance |
string |
Path |
processId |
process id that new instance should be created from |
string |
Body |
body |
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/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/processes/evaluation/instances/correlation/john-evaluation-2019
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
10<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<long-type>
<value>10</value>
</long-type>Process Queries
Returns all process instances for a specified KIE container.
GET /server/queries/containers/{containerId}/process/instances
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
containerId |
container id to filter process instance |
string |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Query |
sort |
optional sort column, no default |
string |
|
Query |
sortOrder |
optional sort direction (asc, desc) - defaults to asc |
boolean |
|
Query |
status |
optional process instance status (active, completed, aborted) - defaults ot active (1) only |
< enum (1, 2, 3) > array(multi) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/queries/containers/string/process/instances
Example HTTP response
Response 200
{
"process-instance": [
{
"process-instance-id": 1,
"process-id": "Employee_Rostering.Process1",
"process-name": "Process1",
"process-version": "1.0",
"process-instance-state": 1,
"container-id": "employee-rostering",
"initiator": "baAdmin",
"start-date": {
"java.util.Date": 1539184095041
},
"process-instance-desc": "Process1",
"correlation-key": "1",
"parent-instance-id": -1,
"sla-compliance": 0,
"sla-due-date": null,
"active-user-tasks": null,
"process-instance-variables": null
},
{
"process-instance-id": 2,
"process-id": "Employee_Rostering.Process2",
"process-name": "Process2",
"process-version": "1.0",
"process-instance-state": 1,
"container-id": "employee-rostering",
"initiator": "baAdmin",
"start-date": {
"java.util.Date": 1539184303976
},
"process-instance-desc": "Process2",
"correlation-key": "2",
"parent-instance-id": -1,
"sla-compliance": 0,
"sla-due-date": null,
"active-user-tasks": null,
"process-instance-variables": null
}
]
}Returns all process definitions in a specified KIE container.
GET /server/queries/containers/{containerId}/processes/definitions
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
containerId |
container id to filter process definitions |
string |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Query |
sort |
optional sort column, no default |
string |
|
Query |
sortOrder |
optional sort direction (asc, desc) - defaults to asc |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/queries/containers/string/processes/definitions
Example HTTP response
Response 200
{
"processes": [
{
"associatedEntities": null,
"serviceTasks": null,
"processVariables": null,
"reusableSubProcesses": null,
"process-id": "Employee_Rostering.Process1",
"process-name": "Process1",
"process-version": "1.0",
"package": "employeerostering.employeerostering",
"container-id": "employee-rostering",
"dynamic": false
}
]
}Returns information about a specified process definition in a specified KIE container.
GET /server/queries/containers/{containerId}/processes/definitions/{processId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that process definition belongs to |
string |
Path |
processId |
process id to load process definition |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/queries/containers/string/processes/definitions/string
Example HTTP response
Response 200
{
"associatedEntities": {
"Qualify": [
"approver"
],
"Final Approval": [
"manager"
],
"Correct Data": [
"broker"
],
"Increase Down Payment": [
"broker"
]
},
"serviceTasks": {},
"processVariables": {
"inlimit": "Boolean",
"application": "com.myspace.mortgage_app.Application",
"incdownpayment": "Boolean"
},
"reusableSubProcesses": [],
"process-id": "Mortgage_Process.MortgageApprovalProcess",
"process-name": "MortgageApprovalProcess",
"process-version": "1.0",
"package": "com.myspace.mortgage_app",
"container-id": "mortgage-process_1.0.0-SNAPSHOT",
"dynamic": false
}Returns all process definitions.
GET /server/queries/processes/definitions
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
filter |
process id or name to filter process definitions |
string |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Query |
sort |
optional sort column, no default |
string |
|
Query |
sortOrder |
optional sort direction (asc, desc) - defaults to asc |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/queries/processes/definitions
Example HTTP response
Response 200
{
"processes": [
{
"associatedEntities": null,
"serviceTasks": null,
"processVariables": null,
"reusableSubProcesses": null,
"process-id": "Employee_Rostering.Process1",
"process-name": "Process1",
"process-version": "1.0",
"package": "employeerostering.employeerostering",
"container-id": "employee-rostering",
"dynamic": false
}
]
}Returns all process definitions for a specified process.
GET /server/queries/processes/definitions/{processId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
processId |
process id to load process definition |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/queries/processes/definitions/string
Example HTTP response
Response 200
{
"processes": [
{
"associatedEntities": null,
"serviceTasks": null,
"processVariables": null,
"reusableSubProcesses": null,
"process-id": "Employee_Rostering.Process1",
"process-name": "Process1",
"process-version": "1.0",
"package": "employeerostering.employeerostering",
"container-id": "employee-rostering",
"dynamic": false
}
]
}Returns information about a single process instance with a specified correlation key.
GET /server/queries/processes/instance/correlation/{correlationKey}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
correlationKey |
correlation key associated with process instance |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/queries/processes/instance/correlation/string
Example HTTP response
Response 200
{
"process-instance-id": 1,
"process-id": "Employee_Rostering.Process1",
"process-name": "Process1",
"process-version": "1.0",
"process-instance-state": 1,
"container-id": "employee-rostering",
"initiator": "baAdmin",
"start-date": {
"java.util.Date": 1539184095041
},
"process-instance-desc": "Process1",
"correlation-key": "1",
"parent-instance-id": -1,
"sla-compliance": 0,
"sla-due-date": null,
"active-user-tasks": null,
"process-instance-variables": {
"initiator": "baAdmin"
}
}Returns all process instances filtered by optional parameters.
GET /server/queries/processes/instances
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
initiator |
optional process instance initiator - user who started process instance to filter process instances |
string |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Query |
processName |
optional process name to filter process instances |
string |
|
Query |
sort |
optional sort column, no default |
string |
|
Query |
sortOrder |
optional sort direction (asc, desc) - defaults to asc |
boolean |
|
Query |
status |
optional process instance status (active, completed, aborted) - defaults ot active (1) only |
< enum (1, 2, 3) > array(multi) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/queries/processes/instances
Example HTTP response
Response 200
{
"process-instance": [
{
"process-instance-id": 1,
"process-id": "Employee_Rostering.Process1",
"process-name": "Process1",
"process-version": "1.0",
"process-instance-state": 1,
"container-id": "employee-rostering",
"initiator": "baAdmin",
"start-date": {
"java.util.Date": 1539184095041
},
"process-instance-desc": "Process1",
"correlation-key": "1",
"parent-instance-id": -1,
"sla-compliance": 0,
"sla-due-date": null,
"active-user-tasks": null,
"process-instance-variables": null
},
{
"process-instance-id": 2,
"process-id": "Employee_Rostering.Process2",
"process-name": "Process2",
"process-version": "1.0",
"process-instance-state": 1,
"container-id": "employee-rostering",
"initiator": "baAdmin",
"start-date": {
"java.util.Date": 1539184303976
},
"process-instance-desc": "Process2",
"correlation-key": "2",
"parent-instance-id": -1,
"sla-compliance": 0,
"sla-due-date": null,
"active-user-tasks": null,
"process-instance-variables": null
}
]
}Returns process instances with a specified correlation key.
GET /server/queries/processes/instances/correlation/{correlationKey}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
correlationKey |
correlation key to filter process instance, can be given as partial correlation key like in starts with approach |
string |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Query |
sort |
optional sort column, no default |
string |
|
Query |
sortOrder |
optional sort direction (asc, desc) - defaults to asc |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/queries/processes/instances/correlation/string
Example HTTP response
Response 200
{
"process-instance": [
{
"process-instance-id": 1,
"process-id": "Employee_Rostering.Process1",
"process-name": "Process1",
"process-version": "1.0",
"process-instance-state": 1,
"container-id": "employee-rostering",
"initiator": "baAdmin",
"start-date": {
"java.util.Date": 1539184095041
},
"process-instance-desc": "Process1",
"correlation-key": "1",
"parent-instance-id": -1,
"sla-compliance": 0,
"sla-due-date": null,
"active-user-tasks": null,
"process-instance-variables": null
},
{
"process-instance-id": 2,
"process-id": "Employee_Rostering.Process2",
"process-name": "Process2",
"process-version": "1.0",
"process-instance-state": 1,
"container-id": "employee-rostering",
"initiator": "baAdmin",
"start-date": {
"java.util.Date": 1539184303976
},
"process-instance-desc": "Process2",
"correlation-key": "2",
"parent-instance-id": -1,
"sla-compliance": 0,
"sla-due-date": null,
"active-user-tasks": null,
"process-instance-variables": null
}
]
}Returns process instances with a specified variable.
GET /server/queries/processes/instances/variables/{varName}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
varName |
variable name to filter process instance |
string |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Query |
sort |
optional sort column, no default |
string |
|
Query |
sortOrder |
optional sort direction (asc, desc) - defaults to asc |
boolean |
|
Query |
status |
optional process instance status (active, completed, aborted) - defaults ot active (1) only |
< enum (1, 2, 3) > array(multi) |
|
Query |
varValue |
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 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/queries/processes/instances/variables/string
Example HTTP response
Response 200
{
"process-instance": [
{
"process-instance-id": 1,
"process-id": "Employee_Rostering.Process1",
"process-name": "Process1",
"process-version": "1.0",
"process-instance-state": 1,
"container-id": "employee-rostering",
"initiator": "baAdmin",
"start-date": {
"java.util.Date": 1539184095041
},
"process-instance-desc": "Process1",
"correlation-key": "1",
"parent-instance-id": -1,
"sla-compliance": 0,
"sla-due-date": null,
"active-user-tasks": null,
"process-instance-variables": null
},
{
"process-instance-id": 2,
"process-id": "Employee_Rostering.Process2",
"process-name": "Process2",
"process-version": "1.0",
"process-instance-state": 1,
"container-id": "employee-rostering",
"initiator": "baAdmin",
"start-date": {
"java.util.Date": 1539184303976
},
"process-instance-desc": "Process2",
"correlation-key": "2",
"parent-instance-id": -1,
"sla-compliance": 0,
"sla-due-date": null,
"active-user-tasks": null,
"process-instance-variables": null
}
]
}Returns information about a specified process instance.
GET /server/queries/processes/instances/{processInstanceId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
processInstanceId |
process instance id to retrieve process instance |
integer (int64) |
Query |
withVars |
load process instance variables or not, defaults to false |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Process instance id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/queries/processes/instances/0
Example HTTP response
Response 200
{
"process-instance-id": 1,
"process-id": "Employee_Rostering.Process1",
"process-name": "Process1",
"process-version": "1.0",
"process-instance-state": 1,
"container-id": "employee-rostering",
"initiator": "baAdmin",
"start-date": {
"java.util.Date": 1539184095041
},
"process-instance-desc": "Process1",
"correlation-key": "1",
"parent-instance-id": -1,
"sla-compliance": 0,
"sla-due-date": null,
"active-user-tasks": null,
"process-instance-variables": {
"initiator": "baAdmin"
}
}Returns node instances for a specified process instance.
GET /server/queries/processes/instances/{processInstanceId}/nodes/instances
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
processInstanceId |
process instance id to to retrive history for |
integer (int64) |
|
Query |
activeOnly |
include active nodes only |
boolean |
|
Query |
completedOnly |
include completed nodes only |
boolean |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/queries/processes/instances/0/nodes/instances
Example HTTP response
Response 200
{
"node-instance": [
{
"node-instance-id": 1,
"node-name": "Task",
"process-instance-id": 2,
"work-item-id": 2,
"container-id": "employee-rostering",
"start-date": {
"java.util.Date": 1539184095048
},
"node-id": "_5F8EED98-433C-4E7B-97BC-0E70615F13CB",
"node-type": "HumanTaskNode",
"node-connection": "_E89FEB0F-B8E1-4138-9DF0-397C9F9A6512",
"node-completed": false,
"reference-id": null,
"sla-compliance": 0,
"sla-due-date": null
}
]
}Returns current variable values of a specified process instance.
GET /server/queries/processes/instances/{processInstanceId}/variables/instances
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
processInstanceId |
process instance id to load variables current state (latest value) for |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/queries/processes/instances/0/variables/instances
Example HTTP response
Response 200
{
"variable-instance": [
{
"name": "initiator",
"old-value": "",
"value": "baAdmin",
"process-instance-id": 2,
"modification-date": {
"java.util.Date": 1539610491992
}
},
{
"name": "application",
"old-value": "com.myspace.mortgage_app.Application@bd449b3",
"value": "com.myspace.mortgage_app.Application@bd449b3",
"process-instance-id": 2,
"modification-date": {
"java.util.Date": 1539610492006
}
}
]
}Returns the history of a specified variable in a specified process instance.
GET /server/queries/processes/instances/{processInstanceId}/variables/instances/{varName}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
processInstanceId |
process instance id to load variable history for |
integer (int64) |
|
Path |
varName |
variable name that history should be loaded for |
string |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/queries/processes/instances/0/variables/instances/string
Example HTTP response
Response 200
{
"variable-instance": [
{
"name": "initiator",
"old-value": "",
"value": "baAdmin",
"process-instance-id": 2,
"modification-date": {
"java.util.Date": 1539610491992
}
},
{
"name": "application",
"old-value": "com.myspace.mortgage_app.Application@bd449b3",
"value": "com.myspace.mortgage_app.Application@bd449b3",
"process-instance-id": 2,
"modification-date": {
"java.util.Date": 1539610492006
}
}
]
}Returns node instances for a specified work item in a specified process instance.
GET /server/queries/processes/instances/{processInstanceId}/wi-nodes/instances/{workItemId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
processInstanceId |
process instance id that work item belongs to |
integer (int64) |
Path |
workItemId |
work item id to retrieve node instance for |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Node instance id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/queries/processes/instances/0/wi-nodes/instances/0
Example HTTP response
Response 200
{
"node-instance-id": 6,
"node-name": "Correct Data",
"process-instance-id": 7,
"work-item-id": 9,
"container-id": "mortgage-process2",
"start-date": {
"java.util.Date": 1539810634380
},
"node-id": "_011ED858-F841-4C44-B0F1-F3BE388ADDA5",
"node-type": "HumanTaskNode",
"node-connection": null,
"node-completed": false,
"reference-id": null,
"sla-compliance": 0,
"sla-due-date": null
}Returns all process instances for a specified process.
GET /server/queries/processes/{processId}/instances
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
processId |
process id to filter process instance |
string |
|
Query |
initiator |
optinal process instance initiator - user who started process instance to filtr process instances |
string |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Query |
sort |
optional sort column, no default |
string |
|
Query |
sortOrder |
optional sort direction (asc, desc) - defaults to asc |
boolean |
|
Query |
status |
optional process instance status (active, completed, aborted) - defaults ot active (1) only |
< enum (1, 2, 3) > array(multi) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/queries/processes/string/instances
Example HTTP response
Response 200
{
"process-instance": [
{
"process-instance-id": 1,
"process-id": "Employee_Rostering.Process1",
"process-name": "Process1",
"process-version": "1.0",
"process-instance-state": 1,
"container-id": "employee-rostering",
"initiator": "baAdmin",
"start-date": {
"java.util.Date": 1539184095041
},
"process-instance-desc": "Process1",
"correlation-key": "1",
"parent-instance-id": -1,
"sla-compliance": 0,
"sla-due-date": null,
"active-user-tasks": null,
"process-instance-variables": null
},
{
"process-instance-id": 2,
"process-id": "Employee_Rostering.Process2",
"process-name": "Process2",
"process-version": "1.0",
"process-instance-state": 1,
"container-id": "employee-rostering",
"initiator": "baAdmin",
"start-date": {
"java.util.Date": 1539184303976
},
"process-instance-desc": "Process2",
"correlation-key": "2",
"parent-instance-id": -1,
"sla-compliance": 0,
"sla-due-date": null,
"active-user-tasks": null,
"process-instance-variables": null
}
]
}Returns all task instances.
GET /server/queries/tasks/instances
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Query |
sort |
optional sort column, no default |
string |
|
Query |
sortOrder |
optional sort direction (asc, desc) - defaults to asc |
boolean |
|
Query |
user |
optional user id to be used instead of authenticated user - only when bypass authenticated user is enabled |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/queries/tasks/instances
Example HTTP response
Response 200
{
"task-summary": [
{
"task-id": "2",
"task-name": "Self Evaluation",
"task-subject": "",
"task-description": "Please perform a self-evalutation.",
"task-status": "Ready",
"task-priority": "0",
"task-is-skippable": "false",
"task-created-by": "John",
"task-created-on": "2016-04-05T15:09:14.206+02:00",
"task-activation-time": "2016-04-05T15:09:14.206+02:00",
"task-proc-inst-id": "2",
"task-proc-def-id": "evaluation",
"task-container-id": "myContainer",
"task-parent-id": "-1"
},
{
"task-id": "1",
"task-name": "Self Evaluation",
"task-subject": "",
"task-description": "Please perform a self-evalutation.",
"task-status": "InProgress",
"task-priority": "0",
"task-is-skippable": "false",
"task-actual-owner": "kiesu",
"task-created-by": "John",
"task-created-on": "2016-04-05T15:05:06.508+02:00",
"task-activation-time": "2016-04-05T15:05:06.508+02:00",
"task-proc-inst-id": "1",
"task-proc-def-id": "evaluation",
"task-container-id": "myContainer",
"task-parent-id": "-1"
}
]
}Returns task instances assigned to business administrators.
GET /server/queries/tasks/instances/admins
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Query |
sort |
optional sort column, no default |
string |
|
Query |
sortOrder |
optional sort direction (asc, desc) - defaults to asc |
boolean |
|
Query |
status |
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 user id to be used instead of authenticated user - only when bypass authenticated user is enabled |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/queries/tasks/instances/admins
Example HTTP response
Response 200
{
"task-summary": [
{
"task-id": "2",
"task-name": "Self Evaluation",
"task-subject": "",
"task-description": "Please perform a self-evalutation.",
"task-status": "Ready",
"task-priority": "0",
"task-is-skippable": "false",
"task-created-by": "John",
"task-created-on": "2016-04-05T15:09:14.206+02:00",
"task-activation-time": "2016-04-05T15:09:14.206+02:00",
"task-proc-inst-id": "2",
"task-proc-def-id": "evaluation",
"task-container-id": "myContainer",
"task-parent-id": "-1"
},
{
"task-id": "1",
"task-name": "Self Evaluation",
"task-subject": "",
"task-description": "Please perform a self-evalutation.",
"task-status": "InProgress",
"task-priority": "0",
"task-is-skippable": "false",
"task-actual-owner": "kiesu",
"task-created-by": "John",
"task-created-on": "2016-04-05T15:05:06.508+02:00",
"task-activation-time": "2016-04-05T15:05:06.508+02:00",
"task-proc-inst-id": "1",
"task-proc-def-id": "evaluation",
"task-container-id": "myContainer",
"task-parent-id": "-1"
}
]
}Returns task instances that the querying user owns.
GET /server/queries/tasks/instances/owners
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Query |
sort |
optional sort column, no default |
string |
|
Query |
sortOrder |
optional sort direction (asc, desc) - defaults to asc |
boolean |
|
Query |
status |
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 user id to be used instead of authenticated user - only when bypass authenticated user is enabled |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/queries/tasks/instances/owners
Example HTTP response
Response 200
{
"task-summary": [
{
"task-id": "2",
"task-name": "Self Evaluation",
"task-subject": "",
"task-description": "Please perform a self-evalutation.",
"task-status": "Ready",
"task-priority": "0",
"task-is-skippable": "false",
"task-created-by": "John",
"task-created-on": "2016-04-05T15:09:14.206+02:00",
"task-activation-time": "2016-04-05T15:09:14.206+02:00",
"task-proc-inst-id": "2",
"task-proc-def-id": "evaluation",
"task-container-id": "myContainer",
"task-parent-id": "-1"
},
{
"task-id": "1",
"task-name": "Self Evaluation",
"task-subject": "",
"task-description": "Please perform a self-evalutation.",
"task-status": "InProgress",
"task-priority": "0",
"task-is-skippable": "false",
"task-actual-owner": "kiesu",
"task-created-by": "John",
"task-created-on": "2016-04-05T15:05:06.508+02:00",
"task-activation-time": "2016-04-05T15:05:06.508+02:00",
"task-proc-inst-id": "1",
"task-proc-def-id": "evaluation",
"task-container-id": "myContainer",
"task-parent-id": "-1"
}
]
}Returns tasks with a user defined as a potential owner.
GET /server/queries/tasks/instances/pot-owners
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
filter |
optional custom filter for task data |
string |
|
Query |
groups |
optional group names to include in the query |
< string > array(multi) |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Query |
sort |
optional sort column, no default |
string |
|
Query |
sortOrder |
optional sort direction (asc, desc) - defaults to asc |
boolean |
|
Query |
status |
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 user id to be used instead of authenticated user - only when bypass authenticated user is enabled |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/queries/tasks/instances/pot-owners
Example HTTP response
Response 200
{
"task-summary": [
{
"task-id": "2",
"task-name": "Self Evaluation",
"task-subject": "",
"task-description": "Please perform a self-evalutation.",
"task-status": "Ready",
"task-priority": "0",
"task-is-skippable": "false",
"task-created-by": "John",
"task-created-on": "2016-04-05T15:09:14.206+02:00",
"task-activation-time": "2016-04-05T15:09:14.206+02:00",
"task-proc-inst-id": "2",
"task-proc-def-id": "evaluation",
"task-container-id": "myContainer",
"task-parent-id": "-1"
},
{
"task-id": "1",
"task-name": "Self Evaluation",
"task-subject": "",
"task-description": "Please perform a self-evalutation.",
"task-status": "InProgress",
"task-priority": "0",
"task-is-skippable": "false",
"task-actual-owner": "kiesu",
"task-created-by": "John",
"task-created-on": "2016-04-05T15:05:06.508+02:00",
"task-activation-time": "2016-04-05T15:05:06.508+02:00",
"task-proc-inst-id": "1",
"task-proc-def-id": "evaluation",
"task-container-id": "myContainer",
"task-parent-id": "-1"
}
]
}Returns task instances associated with a specified process instance.
GET /server/queries/tasks/instances/process/{processInstanceId}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
processInstanceId |
process instance id to filter task instances |
integer (int64) |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Query |
sort |
optional sort column, no default |
string |
|
Query |
sortOrder |
optional sort direction (asc, desc) - defaults to asc |
boolean |
|
Query |
status |
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 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/queries/tasks/instances/process/0
Example HTTP response
Response 200
{
"task-summary": [
{
"task-id": "2",
"task-name": "Self Evaluation",
"task-subject": "",
"task-description": "Please perform a self-evalutation.",
"task-status": "Ready",
"task-priority": "0",
"task-is-skippable": "false",
"task-created-by": "John",
"task-created-on": "2016-04-05T15:09:14.206+02:00",
"task-activation-time": "2016-04-05T15:09:14.206+02:00",
"task-proc-inst-id": "2",
"task-proc-def-id": "evaluation",
"task-container-id": "myContainer",
"task-parent-id": "-1"
},
{
"task-id": "1",
"task-name": "Self Evaluation",
"task-subject": "",
"task-description": "Please perform a self-evalutation.",
"task-status": "InProgress",
"task-priority": "0",
"task-is-skippable": "false",
"task-actual-owner": "kiesu",
"task-created-by": "John",
"task-created-on": "2016-04-05T15:05:06.508+02:00",
"task-activation-time": "2016-04-05T15:05:06.508+02:00",
"task-proc-inst-id": "1",
"task-proc-def-id": "evaluation",
"task-container-id": "myContainer",
"task-parent-id": "-1"
}
]
}Returns task instances with a specified variable.
GET /server/queries/tasks/instances/variables/{varName}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
varName |
name of the variable used to fiter tasks |
string |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Query |
sort |
optional sort column, no default |
string |
|
Query |
sortOrder |
optional sort direction (asc, desc) - defaults to asc |
boolean |
|
Query |
status |
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 user id to be used instead of authenticated user - only when bypass authenticated user is enabled |
string |
|
Query |
varValue |
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 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/queries/tasks/instances/variables/string
Example HTTP response
Response 200
{
"task-summary": [
{
"task-id": "2",
"task-name": "Self Evaluation",
"task-subject": "",
"task-description": "Please perform a self-evalutation.",
"task-status": "Ready",
"task-priority": "0",
"task-is-skippable": "false",
"task-created-by": "John",
"task-created-on": "2016-04-05T15:09:14.206+02:00",
"task-activation-time": "2016-04-05T15:09:14.206+02:00",
"task-proc-inst-id": "2",
"task-proc-def-id": "evaluation",
"task-container-id": "myContainer",
"task-parent-id": "-1"
},
{
"task-id": "1",
"task-name": "Self Evaluation",
"task-subject": "",
"task-description": "Please perform a self-evalutation.",
"task-status": "InProgress",
"task-priority": "0",
"task-is-skippable": "false",
"task-actual-owner": "kiesu",
"task-created-by": "John",
"task-created-on": "2016-04-05T15:05:06.508+02:00",
"task-activation-time": "2016-04-05T15:05:06.508+02:00",
"task-proc-inst-id": "1",
"task-proc-def-id": "evaluation",
"task-container-id": "myContainer",
"task-parent-id": "-1"
}
]
}Returns task instances with a specified work item.
GET /server/queries/tasks/instances/workitem/{workItemId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
workItemId |
work item id to load task associated with |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Task not found for given work item id |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/queries/tasks/instances/workitem/0
Example HTTP response
Response 200
{
"task-id": 1,
"task-priority": 0,
"task-name": "Self Evaluation",
"task-subject": null,
"task-description": "Please perform a self-evalutation.",
"task-type": null,
"task-form": null,
"task-status": "Ready",
"task-actual-owner": "kiesu",
"task-created-by": "Jane",
"task-created-on": {
"java.util.Date": 1539623679113
},
"task-activation-time": {
"java.util.Date": 1539623679113
},
"task-expiration-time": null,
"task-skippable": null,
"task-workitem-id": null,
"task-process-instance-id": 4,
"task-parent-id": null,
"task-process-id": "Mortgage_Process.MortgageApprovalProcess",
"task-container-id": "mortgage-process_1.0.0-SNAPSHOT",
"task-pot-owners": "Jane",
"task-excl-owners": null,
"task-business-admins": "John",
"task-input-data": null,
"task-output-data": null
}Returns information about a specified task instance.
GET /server/queries/tasks/instances/{taskInstanceId}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
taskInstanceId |
task id to load task instance |
integer (int64) |
|
Query |
withSLA |
optional include SLA data - defaults to false |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Task not found for given id |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/queries/tasks/instances/0
Example HTTP response
Response 200
{
"task-id": 1,
"task-priority": 0,
"task-name": "Self Evaluation",
"task-subject": null,
"task-description": "Please perform a self-evalutation.",
"task-type": null,
"task-form": null,
"task-status": "Ready",
"task-actual-owner": "kiesu",
"task-created-by": "Jane",
"task-created-on": {
"java.util.Date": 1539623679113
},
"task-activation-time": {
"java.util.Date": 1539623679113
},
"task-expiration-time": null,
"task-skippable": null,
"task-workitem-id": null,
"task-process-instance-id": 4,
"task-parent-id": null,
"task-process-id": "Mortgage_Process.MortgageApprovalProcess",
"task-container-id": "mortgage-process_1.0.0-SNAPSHOT",
"task-pot-owners": "Jane",
"task-excl-owners": null,
"task-business-admins": "John",
"task-input-data": null,
"task-output-data": null
}Returns events for a specified task instance.
GET /server/queries/tasks/instances/{taskInstanceId}/events
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
taskInstanceId |
task id to load task events for |
integer (int64) |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Query |
sort |
optional sort column, no default |
string |
|
Query |
sortOrder |
optional sort direction (asc, desc) - defaults to asc |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/queries/tasks/instances/0/events
Example HTTP response
Response 200
{
"task-event-instance": [
{
"task-event-id": 4,
"task-id": 4,
"task-event-type": "STARTED",
"task-event-user": "Mortgage_Process.MortgageApprovalProcess",
"task-event-date": {
"java.util.Date": 1539623679130
},
"task-process-instance-id": 4,
"task-work-item-id": 4,
"task-event-message": null
}
]
}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 |
Name of the resource to look up |
string |
Path |
provider |
Name of the provider that manages given resource |
string |
Path |
type |
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 |
Name of the resource to look up |
string |
Path |
type |
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"Task Instance Administration
Returns all task execution errors for a specified KIE container.
GET /server/admin/containers/{containerId}/tasks/errors
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
|
Query |
includeAck |
optional flag that indicates if acknowledged errors should also be collected, defaults to false |
boolean |
|
Query |
name |
optional name of the task to filter by |
string |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Query |
process |
optional process id that the task belongs to to filter by |
string |
|
Query |
sort |
optional sort column, no default |
string |
|
Query |
sortOrder |
optional sort direction (asc, desc) - defaults to asc |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/admin/containers/evaluation_1.0.0-SNAPSHOT/tasks/errors
Example HTTP response
Response 200
{
"error-instance": [
{
"id": "54b04160-6242-475d-9452-0df3678123b0",
"type": "Process",
"container-id": "mortgage-process_1.0.0-SNAPSHOT",
"process-instance-id": 4,
"process-id": "Mortgage_Process.MortgageApprovalProcess",
"activity-id": 12,
"activity-name": "Validation",
"job-id": null,
"error-msg": "[Mortgage_Process.MortgageApprovalProcess:4 - Validation:3] -- [Mortgage_Process.MortgageApprovalProcess:4 - Validation:3] -- null",
"error": null,
"acknowledged": false,
"acknowledged-by": null,
"acknowledged-at": null,
"error-date": 1539627373788
},
{
"id": "a7982044-019d-4d4a-be3f-781f4ddca1df",
"type": "Process",
"container-id": "mortgage-process_1.0.0-SNAPSHOT",
"process-instance-id": 4,
"process-id": "Mortgage_Process.MortgageApprovalProcess",
"activity-id": 12,
"activity-name": "Validation",
"job-id": null,
"error-msg": "[Mortgage_Process.MortgageApprovalProcess:4 - Validation:3] -- [Mortgage_Process.MortgageApprovalProcess:4 - Validation:3] -- null",
"error": null,
"acknowledged": false,
"acknowledged-by": null,
"acknowledged-at": null,
"error-date": 1539627364193
}
]
}Acknowledges one or more task execution errors in a specified KIE container.
PUT /server/admin/containers/{containerId}/tasks/errors
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that errors belong to |
string |
Query |
errorId |
list of identifiers of execution errors to be acknowledged |
< string > array(multi) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
404 |
Task instance or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/admin/containers/evaluation_1.0.0-SNAPSHOT/tasks/errors?errorId=string
Returns information about a specified task execution error.
GET /server/admin/containers/{containerId}/tasks/errors/{errorId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that error belongs to |
string |
Path |
errorId |
identifier of the execution error to load |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Task instance or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/admin/containers/evaluation_1.0.0-SNAPSHOT/tasks/errors/xxx-yyy-zzz
Example HTTP response
Response 200
{
"id": "a7982044-019d-4d4a-be3f-781f4ddca1df",
"type": "Process",
"container-id": "mortgage-process_1.0.0-SNAPSHOT",
"process-instance-id": 4,
"process-id": "Mortgage_Process.MortgageApprovalProcess",
"activity-id": 12,
"activity-name": "Validation",
"job-id": null,
"error-msg": "[Mortgage_Process.MortgageApprovalProcess:4 - Validation:3] -- [Mortgage_Process.MortgageApprovalProcess:4 - Validation:3] -- null",
"error": null,
"acknowledged": false,
"acknowledged-by": null,
"acknowledged-at": null,
"error-date": 1539627364193
}Acknowledges a specified task execution error.
PUT /server/admin/containers/{containerId}/tasks/errors/{errorId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that error belongs to |
string |
Path |
errorId |
identifier of the execution error to be acknowledged |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
404 |
Task instance or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/admin/containers/evaluation_1.0.0-SNAPSHOT/tasks/errors/xxx-yyy-zzz
Adds business administrator users or groups to a specified task instance.
PUT /server/admin/containers/{containerId}/tasks/{taskInstanceId}/admins
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
|
Path |
taskInstanceId |
identifier of task instance to be updated |
integer (int64) |
|
Query |
remove |
optional flag that indicates if existing business admins should be removed, defaults to false |
boolean |
|
Body |
body |
list of users/groups to be added as business admins, as OrgEntities type |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
404 |
Task instance or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Consumes
-
application/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/admin/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/admins
Request body
{
"users" : [ "john" ],
"groups" : null
}<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<org-entities>
<users>john</users>
</org-entities>Deletes specified groups previously added as business administrators for a specified task instance.
DELETE /server/admin/containers/{containerId}/tasks/{taskInstanceId}/admins/groups/{entityId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
Path |
entityId |
list of groups to be removed from business admin list |
string |
Path |
taskInstanceId |
identifier of task instance to be updated |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
404 |
Task instance or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/admin/containers/string/tasks/0/admins/groups/HR
Deletes specified users previously added as business administrators for a specified task instance.
DELETE /server/admin/containers/{containerId}/tasks/{taskInstanceId}/admins/users/{entityId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
Path |
entityId |
list of users to be removed from business admin list |
string |
Path |
taskInstanceId |
identifier of task instance to be updated |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
404 |
Task instance or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/admin/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/admins/users/john
Adds input data to a specified task instance.
PUT /server/admin/containers/{containerId}/tasks/{taskInstanceId}/contents/input
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
Path |
taskInstanceId |
identifier of task instance to be updated |
integer (int64) |
Body |
body |
map of data to be set as task inputs, as Map |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
404 |
Task instance or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Consumes
-
application/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/admin/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/contents/input
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>Deletes input data by parameter name from a specified task instance.
DELETE /server/admin/containers/{containerId}/tasks/{taskInstanceId}/contents/input
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
Path |
taskInstanceId |
identifier of task instance to be updated |
integer (int64) |
Query |
name |
one or more names of task inputs to be removed |
< string > array(multi) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
404 |
Task instance or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/admin/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/contents/input?name=string
Deletes output data by parameter name from a specified task instance.
DELETE /server/admin/containers/{containerId}/tasks/{taskInstanceId}/contents/output
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
Path |
taskInstanceId |
identifier of task instance to be updated |
integer (int64) |
Query |
name |
one or more names of task outputs to be removed |
< string > array(multi) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
404 |
Task instance or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/admin/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/contents/output?name=string
Returns task execution errors for a specified task instance.
GET /server/admin/containers/{containerId}/tasks/{taskInstanceId}/errors
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
|
Path |
taskInstanceId |
identifier of the task instance that errors should be collected for |
integer (int64) |
|
Query |
includeAck |
optional flag that indicates if acknowledged errors should also be collected, defaults to false |
boolean |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Query |
sort |
optional sort column, no default |
string |
|
Query |
sortOrder |
optional sort direction (asc, desc) - defaults to asc |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/admin/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/errors
Example HTTP response
Response 200
{
"error-instance": [
{
"id": "54b04160-6242-475d-9452-0df3678123b0",
"type": "Process",
"container-id": "mortgage-process_1.0.0-SNAPSHOT",
"process-instance-id": 4,
"process-id": "Mortgage_Process.MortgageApprovalProcess",
"activity-id": 12,
"activity-name": "Validation",
"job-id": null,
"error-msg": "[Mortgage_Process.MortgageApprovalProcess:4 - Validation:3] -- [Mortgage_Process.MortgageApprovalProcess:4 - Validation:3] -- null",
"error": null,
"acknowledged": false,
"acknowledged-by": null,
"acknowledged-at": null,
"error-date": 1539627373788
},
{
"id": "a7982044-019d-4d4a-be3f-781f4ddca1df",
"type": "Process",
"container-id": "mortgage-process_1.0.0-SNAPSHOT",
"process-instance-id": 4,
"process-id": "Mortgage_Process.MortgageApprovalProcess",
"activity-id": 12,
"activity-name": "Validation",
"job-id": null,
"error-msg": "[Mortgage_Process.MortgageApprovalProcess:4 - Validation:3] -- [Mortgage_Process.MortgageApprovalProcess:4 - Validation:3] -- null",
"error": null,
"acknowledged": false,
"acknowledged-by": null,
"acknowledged-at": null,
"error-date": 1539627364193
}
]
}Adds users and groups to be excluded from being owners for a specified task instance.
PUT /server/admin/containers/{containerId}/tasks/{taskInstanceId}/exl-owners
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
|
Path |
taskInstanceId |
identifier of task instance to be updated |
integer (int64) |
|
Query |
remove |
optional flag that indicates if existing excluded owners should be removed, defaults to false |
boolean |
|
Body |
body |
list of users/groups to be added as excluded owners, as OrgEntities type |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
404 |
Task instance or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Consumes
-
application/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/admin/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/exl-owners
Request body
{
"users" : [ "john" ],
"groups" : null
}<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<org-entities>
<users>john</users>
</org-entities>Deletes specified groups previously added as excluded owners for a specified task instance.
DELETE /server/admin/containers/{containerId}/tasks/{taskInstanceId}/exl-owners/groups/{entityId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
Path |
entityId |
list of groups to be removed from excluded owners list |
string |
Path |
taskInstanceId |
identifier of task instance to be updated |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
404 |
Task instance or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/admin/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/exl-owners/groups/HR
Deletes specified users previously added as excluded owners for a specified task instance.
DELETE /server/admin/containers/{containerId}/tasks/{taskInstanceId}/exl-owners/users/{entityId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
Path |
entityId |
list of users to be removed from excluded owners list |
string |
Path |
taskInstanceId |
identifier of task instance to be updated |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
404 |
Task instance or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/admin/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/exl-owners/users/john
Creates an email notification for the specified task instance and returns the ID of the new notification.
POST /server/admin/containers/{containerId}/tasks/{taskInstanceId}/notifications
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
|
Path |
taskInstanceId |
identifier of task instance to be updated |
integer (int64) |
|
Query |
expiresAt |
time expression for notification |
string |
|
Query |
whenNotCompleted |
optional flag that indicates the type of notification, either whenNotStarted or whenNotCompleted must be set |
boolean |
|
Query |
whenNotStarted |
optional flag that indicates the type of notification, either whenNotStarted or whenNotCompleted must be set |
boolean |
|
Body |
body |
email notification details, as EmailNotification type |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
201 |
successful operation |
integer (int64) |
404 |
Task instance or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Consumes
-
application/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/admin/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/notifications?expiresAt=string
Request body
{
"from" : "test@jbpm.org",
"reply-to" : "no-reply@jbpm.org",
"users" : [ "john" ],
"groups" : null,
"subject" : "reminder",
"body" : "my test content"
}<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<email-notification>
<from>test@jbpm.org</from>
<reply-to>no-reply@jbpm.org</reply-to>
<users>john</users>
<subject>reminder</subject>
<body>my test content</body>
</email-notification>Example HTTP response
Response 200
10Response 201
0Returns notifications created for a specified task instance.
GET /server/admin/containers/{containerId}/tasks/{taskInstanceId}/notifications
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
|
Path |
taskInstanceId |
identifier of task instance to be updated |
integer (int64) |
|
Query |
activeOnly |
optional flag that indicates if active only notifications should be collected, defaults to true |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Task instance or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/admin/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/notifications
Example HTTP response
Response 200
{
"task-notification": [
{
"id": 11070,
"name": null,
"notify-at": 1540396524172,
"users": [
"Sheldon"
],
"groups": [
"IT"
],
"active": true,
"subject": "You hava a task not started",
"content": "You have been assigned to a task (task-id ${taskId}).\n Important technical information that can be of use when working on it:\n - process instance id - ${processInstanceId}\n - work item id - ${workItemId}\n - work item id - ${workItemId}\n Regards from dev team"
}
]
}Deletes a specified email notification from a specified task instance.
DELETE /server/admin/containers/{containerId}/tasks/{taskInstanceId}/notifications/{notificationId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
Path |
notificationId |
identifier of notification to be canceled |
integer (int64) |
Path |
taskInstanceId |
identifier of task instance to be updated |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
404 |
Task instance or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/admin/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/notifications/567
Adds users and groups as potential owners to a specified task instance.
PUT /server/admin/containers/{containerId}/tasks/{taskInstanceId}/pot-owners
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
|
Path |
taskInstanceId |
identifier of task instance to be updated |
integer (int64) |
|
Query |
remove |
optional flag that indicates if existing potential owners should be removed, defaults to false |
boolean |
|
Body |
body |
list of users/groups to be added as potential owners, as OrgEntities type |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
404 |
Task instance or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Consumes
-
application/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/admin/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/pot-owners
Request body
{
"users" : [ "john" ],
"groups" : null
}<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<org-entities>
<users>john</users>
</org-entities>Deletes specified groups previously added as potential owners for a specified task instance.
DELETE /server/admin/containers/{containerId}/tasks/{taskInstanceId}/pot-owners/groups/{entityId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
Path |
entityId |
list of groups to be removed from potantial owners list |
string |
Path |
taskInstanceId |
identifier of task instance to be updated |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
404 |
Task instance or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/admin/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/pot-owners/groups/HR
Deletes specified users previously added as potential owners for a specified task instance.
DELETE /server/admin/containers/{containerId}/tasks/{taskInstanceId}/pot-owners/users/{entityId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
Path |
entityId |
list of users to be removed from potantial owners list |
string |
Path |
taskInstanceId |
identifier of task instance to be updated |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
404 |
Task instance or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/admin/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/pot-owners/users/john
Schedules a specified task instance to be reassigned to specified users or groups and returns the ID of the reassignment.
POST /server/admin/containers/{containerId}/tasks/{taskInstanceId}/reassignments
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
|
Path |
taskInstanceId |
identifier of task instance to be updated |
integer (int64) |
|
Query |
expiresAt |
time expression for reassignmnet |
string |
|
Query |
whenNotCompleted |
optional flag that indicates the type of reassignment, either whenNotStarted or whenNotCompleted must be set |
boolean |
|
Query |
whenNotStarted |
optional flag that indicates the type of reassignment, either whenNotStarted or whenNotCompleted must be set |
boolean |
|
Body |
body |
list of users/groups that task should be reassined to, as OrgEntities type |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
201 |
successful operation |
integer (int64) |
404 |
Task instance or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Consumes
-
application/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/admin/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/reassignments?expiresAt=string
Request body
{
"users" : [ "john" ],
"groups" : null
}<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<org-entities>
<users>john</users>
</org-entities>Example HTTP response
Response 200
10Response 201
0Returns task reassignments for a specified task instance.
GET /server/admin/containers/{containerId}/tasks/{taskInstanceId}/reassignments
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
|
Path |
taskInstanceId |
identifier of task instance to be updated |
integer (int64) |
|
Query |
activeOnly |
optional flag that indicates if active only reassignmnets should be collected, defaults to true |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Task instance or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/admin/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/reassignments
Example HTTP response
Response 200
{
"task-reassignment": [
{
"id": 9995,
"name": "",
"reassign-at": 1540394323872,
"users": [
"John",
"Jane"
],
"groups": [
"IT"
],
"active": true
}
]
}Deletes a specified reassignment for a specified task instance.
DELETE /server/admin/containers/{containerId}/tasks/{taskInstanceId}/reassignments/{reassignmentId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
Path |
reassignmentId |
identifier of reassignment to be canceled |
integer (int64) |
Path |
taskInstanceId |
identifier of task instance to be updated |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
404 |
Task instance or Container Id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/admin/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/reassignments/567
Task Instances
Returns information about a specified task instance.
GET /server/containers/{containerId}/tasks/{taskInstanceId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
Path |
taskInstanceId |
identifier of the task instance that should be loaded |
integer (int64) |
Query |
withAssignments |
optionally loads task people assignments |
boolean |
Query |
withInputData |
optionally loads task input data |
boolean |
Query |
withOutputData |
optionally loads task output data |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Task with given id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/tasks/123
Example HTTP response
Response 200
{
"task-id": 1,
"task-priority": 0,
"task-name": "Self Evaluation",
"task-subject": null,
"task-description": "Please perform a self-evalutation.",
"task-type": null,
"task-form": null,
"task-status": "Ready",
"task-actual-owner": "kiesu",
"task-created-by": "Jane",
"task-created-on": {
"java.util.Date": 1539623679113
},
"task-activation-time": {
"java.util.Date": 1539623679113
},
"task-expiration-time": null,
"task-skippable": null,
"task-workitem-id": null,
"task-process-instance-id": 4,
"task-parent-id": null,
"task-process-id": "Mortgage_Process.MortgageApprovalProcess",
"task-container-id": "mortgage-process_1.0.0-SNAPSHOT",
"task-pot-owners": "Jane",
"task-excl-owners": null,
"task-business-admins": "John",
"task-input-data": null,
"task-output-data": null
}Updates information in a specified task instance.
PUT /server/containers/{containerId}/tasks/{taskInstanceId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
Path |
taskInstanceId |
identifier of the task instance that should be updated |
integer (int64) |
Query |
user |
optional user id to be used instead of authenticated user - only when bypass authenticated user is enabled |
string |
Body |
body |
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/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/tasks/123
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 an attachment to a specified task instance and returns the ID of the new attachment.
POST /server/containers/{containerId}/tasks/{taskInstanceId}/attachments
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
Path |
taskInstanceId |
identifier of the task instance that attachment should be added to |
integer (int64) |
Query |
name |
name of the attachment to be added |
string |
Query |
user |
optional user id to be used instead of authenticated user - only when bypass authenticated user is enabled |
string |
Body |
body |
attachment content, any type can be provided |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Successfull response |
No Content |
404 |
Task with given id not found |
No Content |
500 |
Unexpected error |
No Content |
Consumes
-
application/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/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
10Returns all attachments for a specified task instance.
GET /server/containers/{containerId}/tasks/{taskInstanceId}/attachments
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
Path |
taskInstanceId |
identifier of the task instance that attachments should be loaded for |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Task with given id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/attachments
Example HTTP response
Response 200
{
"task-attachment": [
{
"attachment-id": 1,
"attachment-name": "Task Attachment",
"attachment-added-by": "baAdmin",
"attachment-added-at": {
"java.util.Date": 1540229715779
},
"attachment-type": "java.util.LinkedHashMap",
"attachment-size": 233,
"attachment-content-id": 31
},
{
"attachment-id": 2,
"attachment-name": "Task Attachment 2",
"attachment-added-by": "baAdmin",
"attachment-added-at": {
"java.util.Date": 1540229715780
},
"attachment-type": "java.util.LinkedHashMap",
"attachment-size": 300,
"attachment-content-id": 32
}
]
}Returns information about a specified attachment for a specified task instance.
GET /server/containers/{containerId}/tasks/{taskInstanceId}/attachments/{attachmentId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
attachmentId |
identifier of the attachment to be loaded |
integer (int64) |
Path |
containerId |
container id that task instance belongs to |
string |
Path |
taskInstanceId |
identifier of the task instance that attachment belongs to |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Task with given id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/attachments/567
Example HTTP response
Response 200
{
"Person": {
"name": "john"
}
}Deletes a specified attachment from a specified task instance.
DELETE /server/containers/{containerId}/tasks/{taskInstanceId}/attachments/{attachmentId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
attachmentId |
identifier of the attachment to be deleted |
integer (int64) |
Path |
containerId |
container id that task instance belongs to |
string |
Path |
taskInstanceId |
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/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/attachments/567
Returns the content of a specified attachment for a specified task instance.
GET /server/containers/{containerId}/tasks/{taskInstanceId}/attachments/{attachmentId}/content
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
attachmentId |
identifier of the attachment that content should be loaded from |
integer (int64) |
Path |
containerId |
container id that task instance belongs to |
string |
Path |
taskInstanceId |
identifier of the task instance that attachment belongs to |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Task with given id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/attachments/567/content
Example HTTP response
Response 200
{
"Person": {
"name": "john"
}
}Adds a comment to a specified task instance and returns the ID of the new comment.
POST /server/containers/{containerId}/tasks/{taskInstanceId}/comments
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
Path |
taskInstanceId |
identifier of the task instance that comment should be added to |
integer (int64) |
Body |
body |
comment data as TaskComment |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
201 |
successful operation |
integer (int64) |
404 |
Task with given id not found |
No Content |
500 |
Unexpected error |
No Content |
Consumes
-
application/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/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 200
10Response 201
0Returns all comments in a specified task instance.
GET /server/containers/{containerId}/tasks/{taskInstanceId}/comments
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
Path |
taskInstanceId |
identifier of the task instance that comments should be loaded for |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Task with given id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/comments
Example HTTP response
Response 200
{
"task-comment": [
{
"comment-id": 1,
"comment": "Ensure that this self evaluation is completed before the HR and PM evaluations.",
"comment-added-by": "baAdmin",
"comment-added-at": {
"java.util.Date": 1540238822132
}
},
{
"comment-id": 2,
"comment": "Task must be assigned to administrator.",
"comment-added-by": "baAdmin",
"comment-added-at": {
"java.util.Date": 1540238822140
}
}
]
}Returns a specified comment from a specified task instance.
GET /server/containers/{containerId}/tasks/{taskInstanceId}/comments/{commentId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
commentId |
identifier of the comment to be loaded |
integer (int64) |
Path |
containerId |
container id that task instance belongs to |
string |
Path |
taskInstanceId |
identifier of the task instance that comment belongs to |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Task with given id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/comments/567
Example HTTP response
Response 200
{
"comment-id" : null,
"comment" : "First comment.",
"comment-added-by" : "yoda",
"comment-added-at" : {
"java.util.Date" : 1539939094774
}
}Deletes a specified comment from a specified task instance.
DELETE /server/containers/{containerId}/tasks/{taskInstanceId}/comments/{commentId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
commentId |
identifier of the comment to be deleted |
integer (int64) |
Path |
containerId |
container id that task instance belongs to |
string |
Path |
taskInstanceId |
identifier of the task instance that comment 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/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/comments/567
Returns input data for a specified task instance.
GET /server/containers/{containerId}/tasks/{taskInstanceId}/contents/input
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
Path |
taskInstanceId |
identifier of the task instance that input data should be loaded from |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Task with given id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/contents/input
Example HTTP response
Response 200
{
"application": {
"com.myspace.mortgage_app.Application": {
"applicant": {
"com.myspace.mortgage_app.Applicant": {
"name": "",
"annualincome": 0,
"address": null,
"ssn": 0,
"creditrating": null
}
},
"property": {
"com.myspace.mortgage_app.Property": {
"age": 0,
"address": "",
"locale": "",
"saleprice": 0
}
},
"downpayment": 0,
"amortization": 0,
"mortgageamount": null
}
},
"initiator": "baAdmin"
}Returns output data for a specified task instance.
GET /server/containers/{containerId}/tasks/{taskInstanceId}/contents/output
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
Path |
taskInstanceId |
identifier of the task instance that output data should be loaded from |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Task with given id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/contents/output
Example HTTP response
Response 200
{
"application": {
"com.myspace.mortgage_app.Application": {
"applicant": {
"com.myspace.mortgage_app.Applicant": {
"name": "",
"annualincome": 0,
"address": null,
"ssn": 0,
"creditrating": null
}
},
"property": {
"com.myspace.mortgage_app.Property": {
"age": 0,
"address": "",
"locale": "",
"saleprice": 0
}
},
"downpayment": 0,
"amortization": 0,
"mortgageamount": null
}
},
"initiator": "baAdmin"
}Adds output data to a specified task instance and returns the ID of the new output content.
PUT /server/containers/{containerId}/tasks/{taskInstanceId}/contents/output
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
Path |
taskInstanceId |
identifier of the task instance that data should be saved into |
integer (int64) |
Body |
body |
output data to be saved as Map |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
404 |
Task with given id not found |
No Content |
500 |
Unexpected error |
No Content |
Consumes
-
application/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/contents/output
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>Deletes output data by content ID from a specified task instance.
DELETE /server/containers/{containerId}/tasks/{taskInstanceId}/contents/{contentId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
Path |
contentId |
identifier of the content to be deleted |
integer (int64) |
Path |
taskInstanceId |
identifier of the task instance that content 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/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/contents/567
Updates the description of a specified task instance.
PUT /server/containers/{containerId}/tasks/{taskInstanceId}/description
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
Path |
taskInstanceId |
identifier of the task instance where description should be updated |
integer (int64) |
Body |
body |
description as String |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
404 |
Task with given id not found |
No Content |
500 |
Unexpected error |
No Content |
Consumes
-
application/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/description
Request body
Simple user task.<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<string-type>
<value>Simple user task.</value>
</string-type>Returns all events for a specified task instance.
GET /server/containers/{containerId}/tasks/{taskInstanceId}/events
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
|
Path |
taskInstanceId |
identifier of the task instance that events should be loaded for |
integer (int64) |
|
Query |
page |
optional pagination - at which page to start, defaults to 0 (meaning first) |
integer (int32) |
|
Query |
pageSize |
optional pagination - size of the result, defaults to 10 |
integer (int32) |
|
Query |
sort |
optional sort column, no default |
string |
|
Query |
sortOrder |
optional sort direction (asc, desc) - defaults to asc |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfull response |
No Content |
404 |
Task with given id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/events
Example HTTP response
Response 200
{
"task-event-instance": [
{
"task-event-id": 4,
"task-id": 4,
"task-event-type": "STARTED",
"task-event-user": "Mortgage_Process.MortgageApprovalProcess",
"task-event-date": {
"java.util.Date": 1539623679130
},
"task-process-instance-id": 4,
"task-work-item-id": 4,
"task-event-message": null
}
]
}Updates the expiration date for a specified task instance.
PUT /server/containers/{containerId}/tasks/{taskInstanceId}/expiration
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
Path |
taskInstanceId |
identifier of the task instance where expiration date should be updated |
integer (int64) |
Body |
body |
expiration date as Date |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
404 |
Task with given id not found |
No Content |
500 |
Unexpected error |
No Content |
Consumes
-
application/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/expiration
Request body
{
"java.util.Date" : 1540025263987
}<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<date-type>
<value>2018-10-20T10:47:43.607+02:00</value>
</date-type>Updates the name of a specified task instance.
PUT /server/containers/{containerId}/tasks/{taskInstanceId}/name
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
Path |
taskInstanceId |
identifier of the task instance where name should be updated |
integer (int64) |
Body |
body |
name as String |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
404 |
Task with given id not found |
No Content |
500 |
Unexpected error |
No Content |
Consumes
-
application/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/name
Request body
Simple user task.<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<string-type>
<value>Simple user task.</value>
</string-type>Updates the priority of a specified task instance.
PUT /server/containers/{containerId}/tasks/{taskInstanceId}/priority
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
Path |
taskInstanceId |
identifier of the task instance where priority should be updated |
integer (int64) |
Body |
body |
priority as Integer |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
404 |
Task with given id not found |
No Content |
500 |
Unexpected error |
No Content |
Consumes
-
application/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/priority
Request body
10<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<int-type>
<value>10</value>
</int-type>Marks a specified task instance that can be skipped in a sequence of tasks.
PUT /server/containers/{containerId}/tasks/{taskInstanceId}/skipable
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
Path |
taskInstanceId |
identifier of the task instance where skipable flag should be updated |
integer (int64) |
Body |
body |
skipable flag as Boolean |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
404 |
Task with given id not found |
No Content |
500 |
Unexpected error |
No Content |
Consumes
-
application/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/skipable
Request body
false<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<boolean-type>
<value>false</value>
</boolean-type>Activates a specified task instance to be progressed.
PUT /server/containers/{containerId}/tasks/{taskInstanceId}/states/activated
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
Path |
taskInstanceId |
identifier of the task instance that should be activated |
integer (int64) |
Query |
user |
optional user id to be used instead of authenticated user - only when bypass authenticated user is enabled |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
404 |
Task with given id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/states/activated
Claims (reserves) a specified task instance for the user sending the request.
PUT /server/containers/{containerId}/tasks/{taskInstanceId}/states/claimed
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
Path |
taskInstanceId |
identifier of the task instance that should be claimed |
integer (int64) |
Query |
user |
optional user id to be used instead of authenticated user - only when bypass authenticated user is enabled |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
403 |
User was unable to execute current operation on task with given id due to a no 'current status' match or insufficient permissions |
No Content |
404 |
Task with given id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/states/claimed
Completes a specified task instance.
PUT /server/containers/{containerId}/tasks/{taskInstanceId}/states/completed
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
Path |
taskInstanceId |
identifier of the task instance that should be completed |
integer (int64) |
Query |
auto-progress |
optional flag that allows to directlu claim and start task (if needed) before completion |
boolean |
Query |
user |
optional user id to be used instead of authenticated user - only when bypass authenticated user is enabled |
string |
Body |
body |
optional map of output variables |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
403 |
User was unable to execute current operation on task with given id due to a no 'current status' match or insufficient permissions |
No Content |
404 |
Task with given id not found |
No Content |
500 |
Unexpected error |
No Content |
Consumes
-
application/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/states/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>Delegates a specified task instance to a specified target user as the new task owner.
PUT /server/containers/{containerId}/tasks/{taskInstanceId}/states/delegated
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
Path |
taskInstanceId |
identifier of the task instance that should be delegated |
integer (int64) |
Query |
targetUser |
user that task should be dalegated to |
string |
Query |
user |
optional user id to be used instead of authenticated user - only when bypass authenticated user is enabled |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
403 |
User was unable to execute current operation on task with given id due to a no 'current status' match or insufficient permissions |
No Content |
404 |
Task with given id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/states/delegated?targetUser=string
Exits a specified task instance.
PUT /server/containers/{containerId}/tasks/{taskInstanceId}/states/exited
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
Path |
taskInstanceId |
identifier of the task instance that should be exited |
integer (int64) |
Query |
user |
optional user id to be used instead of authenticated user - only when bypass authenticated user is enabled |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
404 |
Task with given id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/states/exited
Fails a specified task instance.
PUT /server/containers/{containerId}/tasks/{taskInstanceId}/states/failed
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
Path |
taskInstanceId |
identifier of the task instance that should be failed |
integer (int64) |
Query |
user |
optional user id to be used instead of authenticated user - only when bypass authenticated user is enabled |
string |
Body |
body |
optional map of output variables |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
404 |
Task with given id not found |
No Content |
500 |
Unexpected error |
No Content |
Consumes
-
application/json -
application/xml
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/states/failed
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>Forwards a specified task instance to a specified target user for review or for suggested delegation.
PUT /server/containers/{containerId}/tasks/{taskInstanceId}/states/forwarded
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
Path |
taskInstanceId |
identifier of the task instance that should be forwarded |
integer (int64) |
Query |
targetUser |
user that the task should be forwarded to |
string |
Query |
user |
optional user id to be used instead of authenticated user - only when bypass authenticated user is enabled |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
403 |
User was unable to execute current operation on task with given id due to a no 'current status' match or insufficient permissions |
No Content |
404 |
Task with given id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/states/forwarded?targetUser=string
Nominates one or more potential owners to whom the task instance should be assigned.
PUT /server/containers/{containerId}/tasks/{taskInstanceId}/states/nominated
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
Path |
taskInstanceId |
identifier of the task instance that should be nominated |
integer (int64) |
Query |
potOwner |
list of users that the task should be nominated to |
< string > array(multi) |
Query |
user |
optional user id to be used instead of authenticated user - only when bypass authenticated user is enabled |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
403 |
User was unable to execute current operation on task with given id due to a no 'current status' match or insufficient permissions |
No Content |
404 |
Task with given id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/states/nominated?potOwner=string
Releases a specified task instance from being claimed by the task owner.
PUT /server/containers/{containerId}/tasks/{taskInstanceId}/states/released
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
Path |
taskInstanceId |
identifier of the task instance that should be released |
integer (int64) |
Query |
user |
optional user id to be used instead of authenticated user - only when bypass authenticated user is enabled |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
403 |
User was unable to execute current operation on task with given id due to a no 'current status' match or insufficient permissions |
No Content |
404 |
Task with given id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/states/released
Resumes a specified task instance.
PUT /server/containers/{containerId}/tasks/{taskInstanceId}/states/resumed
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
Path |
taskInstanceId |
identifier of the task instance that should be resumed |
integer (int64) |
Query |
user |
optional user id to be used instead of authenticated user - only when bypass authenticated user is enabled |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
404 |
Task with given id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/states/resumed
Skips a specified task instance within the sequence of tasks in the process instance
PUT /server/containers/{containerId}/tasks/{taskInstanceId}/states/skipped
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
Path |
taskInstanceId |
identifier of the task instance that should be skipped |
integer (int64) |
Query |
user |
optional user id to be used instead of authenticated user - only when bypass authenticated user is enabled |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
404 |
Task with given id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/states/skipped
Starts a specified task instance.
PUT /server/containers/{containerId}/tasks/{taskInstanceId}/states/started
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
Path |
taskInstanceId |
identifier of the task instance that should be started |
integer (int64) |
Query |
user |
optional user id to be used instead of authenticated user - only when bypass authenticated user is enabled |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
404 |
Task with given id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/states/started
Stops a specified task instance.
PUT /server/containers/{containerId}/tasks/{taskInstanceId}/states/stopped
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
Path |
taskInstanceId |
identifier of the task instance that should be stopped |
integer (int64) |
Query |
user |
optional user id to be used instead of authenticated user - only when bypass authenticated user is enabled |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
404 |
Task with given id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/states/stopped
Suspends a specified task instance.
PUT /server/containers/{containerId}/tasks/{taskInstanceId}/states/suspended
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
container id that task instance belongs to |
string |
Path |
taskInstanceId |
identifier of the task instance that should be suspended |
integer (int64) |
Query |
user |
optional user id to be used instead of authenticated user - only when bypass authenticated user is enabled |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
404 |
Task with given id not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/json -
application/xml
Example HTTP request
Request path
/server/containers/evaluation_1.0.0-SNAPSHOT/tasks/123/states/suspended
Test Scenario Execution
Execute given test scenario against specified container
POST /server/containers/{containerId}/scesim
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
containerId |
Container id |
string |
Body |
body |
Test scenario file content to be executed |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
successful operation |
|
400 |
Malformed test scenario file |
No Content |
404 |
Container not found |
No Content |
500 |
Unexpected error |
No Content |
Produces
-
application/xml -
application/json
Example HTTP request
Request path
/server/containers/string/scesim
Request body
Example HTTP response
Response 200
{
"type" : "SUCCESS",
"msg" : "string"
}
Paid support and consulting
Want to talk to the experts? Red Hat offers certified binaries with enterprise consulting. See services for more information.