获取列表

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

sortBy

enum<string>

Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter.

Available options:

activityInstanceId,

instanceId,

executionId,

activityId,

activityName,

activityType,

startTime,

endTime,

duration,

definitionId,

occurrence,

tenantId

sortOrder

enum<string>

Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter.

Available options:

asc,

desc

firstResult

integer

Pagination of results. Specifies the index of the first result to return.

maxResults

integer

Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

activityInstanceId

string

Filter by activity instance id.

processInstanceId

string

Filter by process instance id.

processDefinitionId

string

Filter by process definition id.

executionId

string

Filter by the id of the execution that executed the activity instance.

activityId

string

Filter by the activity id (according to BPMN 2.0 XML).

activityName

string

Filter by the activity name (according to BPMN 2.0 XML).

activityType

string

Filter by activity type.

taskAssignee

string

Only include activity instances that are user tasks and assigned to a given user.

finished

boolean

Only include finished activity instances. Value may only be true, as false behaves the same as when the property is not set.

unfinished

boolean

Only include unfinished activity instances. Value may only be true, as false behaves the same as when the property is not set.

canceled

boolean

Only include canceled activity instances. Value may only be true, as false behaves the same as when the property is not set.

completeScope

boolean

Only include activity instances which completed a scope. Value may only be true, as false behaves the same as when the property is not set.

startedBefore

string<date-time>

Restrict to instances that were started before the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

startedAfter

string<date-time>

Restrict to instances that were started after the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

finishedBefore

string<date-time>

Restrict to instances that were finished before the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

finishedAfter

string<date-time>

Restrict to instances that were finished after the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

tenantIdIn

string

Filter by a comma-separated list of ids. An activity instance must have one of the given tenant ids.

withoutTenantId

boolean

Only include historic activity instances that belong to no tenant. Value may only be true, as false is the default behavior.

Response

Request successful.

string | null

The id of the activity instance.

parentActivityInstanceId

string | null

The id of the parent activity instance, for example a sub process instance.

activityId

string | null

The id of the activity that this object is an instance of.

activityName

string | null

The name of the activity that this object is an instance of.

activityType

string | null

The type of the activity that this object is an instance of.

processDefinitionKey

string | null

The key of the process definition that this activity instance belongs to.

processDefinitionId

string | null

The id of the process definition that this activity instance belongs to.

processInstanceId

string | null

The id of the process instance that this activity instance belongs to.

executionId

string | null

The id of the execution that executed this activity instance.

taskId

string | null

The id of the task that is associated to this activity instance. Is only set if the activity is a user task.

assignee

string | null

The assignee of the task that is associated to this activity instance. Is only set if the activity is a user task.

calledProcessInstanceId

string | null

The id of the called process instance. Is only set if the activity is a call activity and the called instance a process instance.

calledCaseInstanceId

string | null

The id of the called case instance. Is only set if the activity is a call activity and the called instance a case instance.

startTime

string<date-time> | null

The time the instance was started. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

endTime

string<date-time> | null

The time the instance ended. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

durationInMillis

integer | null

The time the instance took to finish (in milliseconds).

canceled

boolean | null

If true, this activity instance is canceled.

completeScope

boolean | null

If true, this activity instance did complete a BPMN 2.0 scope.

tenantId

string | null

The tenant id of the activity instance.

removalTime

string<date-time> | null

The time after which the activity instance should be removed by the History Cleanup job. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

rootProcessInstanceId

string | null

The process instance id of the root process instance that initiated the process containing this activity instance.

REST API

Javadoc

Authorizations

Query Parameters

Response