Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Query Parameters
Filter by process definition id.
Filter by a comma-separated list of process definition ids.
Filter by process definition name.
Filter by process definition names that the parameter is a substring of.
Filter by the deployment the id belongs to.
Filter by the deploy time of the deployment the process definition belongs to.
Only selects process definitions that have been deployed after (exclusive) a specific time.
By default, the date must have the
format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g.,
2013-01-23T14:42:45.546+0200.
Filter by the deploy time of the deployment the process definition belongs to.
Only selects process definitions that have been deployed at a specific time (exact match).
By default, the date must have the
format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g.,
2013-01-23T14:42:45.546+0200.
Filter by process definition key, i.e., the id in the BPMN 2.0 XML. Exact match.
Filter by a comma-separated list of process definition keys.
Filter by process definition keys that the parameter is a substring of.
Filter by process definition category. Exact match.
Filter by process definition categories that the parameter is a substring of.
Filter by process definition version.
Only include those process definitions that are latest versions.
Value may only be true, as false is the default behavior.
Filter by the name of the process definition resource. Exact match.
Filter by names of those process definition resources that the parameter is a substring of.
Filter by a user name who is allowed to start the process.
Only include active process definitions.
Value may only be true, as false is the default behavior.
Only include suspended process definitions.
Value may only be true, as false is the default behavior.
Filter by the incident id.
Filter by the incident type. See the User Guide for a list of incident types.
Filter by the incident message. Exact match.
Filter by the incident message that the parameter is a substring of.
Filter by a comma-separated list of tenant ids. A process definition must have one of the given tenant ids.
Only include process definitions which belong to no tenant. Value may only be true, as false is the default behavior.
Include process definitions which belong to no tenant. Can be used in combination with tenantIdIn.
Value may only be true, as false is the default behavior.
Filter by the version tag.
Filter by the version tag that the parameter is a substring of.
Only include process definitions without a versionTag.
Filter by process definitions which are startable in Tasklist..
Filter by process definitions which are not startable in Tasklist.
Filter by process definitions which the user is allowed to start in Tasklist. If the user doesn't have these permissions the result will be empty list. The permissions are:
CREATEpermission for all Process instancesCREATE_INSTANCEandREADpermission on Process definition level
Response
Request successful.
The number of matching instances.