Public Web API: Get a list of process instances

Request

POST /pub/v1/bpm/instance/bytemplateid/{id}/list

Path parameters

Parameter name	Value	Description	Additional
id	uuid	Template ID	Required

Request body

The resource sent in the request body is Get a list of process instances — Request. It contains the following writable properties:

{
    "active": "boolean",
    "filter": {
        "<key>": {}
    },
    "from": "int64",
    "ids": [
        "uuid"
    ],
    "size": "int64",
    "sortExpressions": [
        {
            "ascending": "boolean",
            "field": "string"
        }
    ]
}

Properties

Name	Type	Description	Additional
active	boolean	Show active only (not deleted)	Optional
filter	object	Filtering	Optional
filter.<key>	map of object		Optional
from	int64	Return from item	Optional
ids[]	array of uuid	ID Filetering	Optional
size	int64	Number of returned items (10000 max)	Optional
sortExpressions[]	array	Sorting rules	Optional
sortExpressions[].ascending	boolean	Ascending sorting order flag	Optional
sortExpressions[].field	string	Sort field	Optional

Authorization

This request requires the use of one of following authorisation methods: API key

Response

The following HTTP status codes may be returned:

Status code	Description	Resource
200	OK Model of the list of process instances	Model of the list of process instances (Get a list of process instances)