Sign in

v1

latestOpenAPI 3.0.12026-07-23144735.7 KB
ProcessInstances

List Process Instances

get/api/v1/instances/{agentGroupId}

Path parameters

agentGroupIdinteger required

Agent Group where Process Instances should be fetched from

Query parameters

processGuidsstring[]

Filter by Processes

startTimestring date-time

Filter by Execution start time

endTimestring date-time

Filter by Execution end time

stateFilter'ShowAll' | 'ShowRunning' | 'ShowFinished' | 'ShowSuccessful' | 'ShowFailed' | 'ShowFailedNotAcknowledged'

Filter by Execution state

isChildProcessboolean

Filter by whether process is a child process (i.e. a subprocess, if not started manually)

continuationTokenstring

If there are more results to be shown a continuationToken will be needed to show the next set of results. This token is passed as nextContinuationToken in the result of the previous query. <b>Warning! If any filters except continuationToken are changed between requests the results will be invalid</b>

pageSizeinteger

Maximum page size is 200. Default page size is 50

Response

OK

nextContinuationTokenstring nullable

ContinuationToken to be used in the next query <b>Warning! If any filters except continuationToken are changed between requests the results will be invalid</b> <br>If the token is null there are no more results to fetch with the selected filters</br>