Public Web API: Get a list of process instances by target

Request

POST /pub/v1/bpm/instance/bytarget/list

Request body

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

{
    "active": "boolean",
    "from": "int64",
    "size": "int64",
    "sortExpressions": [
        {
            "ascending": "boolean",
            "field": "string"
        }
    ],
    "target": "string"
}

Properties

Name	Type	Description	Additional
active	boolean	Show active only (not deleted)	Optional
from	int64	Return from item	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
target	string	External object ID	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 by target)