获取列表 - ORION

Get Variable Instances

curl --request GET \
  --url http://{host}:{port}/{contextPath}/variable-instance \
  --header 'Authorization: Basic <encoded-value>'

[
  {
    "id": "someId",
    "name": "amount",
    "type": "Integer",
    "value": 5,
    "processDefinitionId": "aProcessDefinitionId",
    "processInstanceId": "aProcessInstanceId",
    "executionId": "b68b71c9-e310-11e2-beb0-f0def1557726",
    "taskId": null,
    "batchId": null,
    "activityInstanceId": "Task_1:b68b71ca-e310-11e2-beb0-f0def1557726",
    "caseExecutionId": null,
    "caseInstanceId": null,
    "errorMessage": null,
    "tenantId": null
  },
  {
    "id": "someOtherId",
    "name": "amount",
    "type": "Integer",
    "value": 15,
    "processDefinitionId": "aProcessDefinitionId",
    "processInstanceId": "aProcessInstanceId",
    "executionId": "68b71c9-e310-11e2-beb0-f0def1557726",
    "taskId": null,
    "batchId": null,
    "activityInstanceId": "Task_1:b68b71ca-e310-11e2-beb0-f0def1557726",
    "caseExecutionId": null,
    "caseInstanceId": null,
    "errorMessage": null,
    "tenantId": null
  },
  {
    "id": "yetAnotherId",
    "name": "amount",
    "type": "Integer",
    "value": 150,
    "processDefinitionId": "aProcessDefinitionId",
    "processInstanceId": "anotherProcessInstanceId",
    "executionId": "68b71c9-e310-11e2-beb0-f0def1557726",
    "taskId": null,
    "batchId": null,
    "activityInstanceId": "Task_2:b68b71ca-e310-11e2-beb0-f0def1557726",
    "caseExecutionId": null,
    "caseInstanceId": null,
    "errorMessage": null,
    "tenantId": null
  }
]

GET

variable-instance

Get Variable Instances

curl --request GET \
  --url http://{host}:{port}/{contextPath}/variable-instance \
  --header 'Authorization: Basic <encoded-value>'

[
  {
    "id": "someId",
    "name": "amount",
    "type": "Integer",
    "value": 5,
    "processDefinitionId": "aProcessDefinitionId",
    "processInstanceId": "aProcessInstanceId",
    "executionId": "b68b71c9-e310-11e2-beb0-f0def1557726",
    "taskId": null,
    "batchId": null,
    "activityInstanceId": "Task_1:b68b71ca-e310-11e2-beb0-f0def1557726",
    "caseExecutionId": null,
    "caseInstanceId": null,
    "errorMessage": null,
    "tenantId": null
  },
  {
    "id": "someOtherId",
    "name": "amount",
    "type": "Integer",
    "value": 15,
    "processDefinitionId": "aProcessDefinitionId",
    "processInstanceId": "aProcessInstanceId",
    "executionId": "68b71c9-e310-11e2-beb0-f0def1557726",
    "taskId": null,
    "batchId": null,
    "activityInstanceId": "Task_1:b68b71ca-e310-11e2-beb0-f0def1557726",
    "caseExecutionId": null,
    "caseInstanceId": null,
    "errorMessage": null,
    "tenantId": null
  },
  {
    "id": "yetAnotherId",
    "name": "amount",
    "type": "Integer",
    "value": 150,
    "processDefinitionId": "aProcessDefinitionId",
    "processInstanceId": "anotherProcessInstanceId",
    "executionId": "68b71c9-e310-11e2-beb0-f0def1557726",
    "taskId": null,
    "batchId": null,
    "activityInstanceId": "Task_2:b68b71ca-e310-11e2-beb0-f0def1557726",
    "caseExecutionId": null,
    "caseInstanceId": null,
    "errorMessage": null,
    "tenantId": null
  }
]

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

variableName

string

Filter by variable instance name.

variableNameLike

string

Filter by the variable instance name. The parameter can include the wildcard % to express like-strategy such as: starts with (%name), ends with (name%) or contains (%name%).

processInstanceIdIn

string

Only include variable instances which belong to one of the passed and comma-separated process instance ids.

executionIdIn

string

Only include variable instances which belong to one of the passed and comma-separated execution ids.

caseInstanceIdIn

string

Only include variable instances which belong to one of the passed and comma-separated case instance ids.

caseExecutionIdIn

string

Only include variable instances which belong to one of the passed and comma-separated case execution ids.

taskIdIn

string

Only include variable instances which belong to one of the passed and comma-separated task ids.

batchIdIn

string

Only include variable instances which belong to one of the passed and comma-separated batch ids.

activityInstanceIdIn

string

Only include variable instances which belong to one of the passed and comma-separated activity instance ids.

tenantIdIn

string

Only include variable instances which belong to one of the passed and comma-separated tenant ids.

variableValues

string

Only include variable instances that have the certain values. Value filtering expressions are comma-separated and are structured as follows:

A valid parameter value has the form key_operator_value. key is the variable name, operator is the comparison operator to be used and value the variable value.

Note: Values are always treated as String objects on server side.

Valid operator values are: eq - equal to; neq - not equal to; gt - greater than; gteq - greater than or equal to; lt - lower than; lteq - lower than or equal to; like. key and value may not contain underscore or comma characters.

variableNamesIgnoreCase

boolean

Match all variable names provided in variableValues case-insensitively. If set to true variableName and variablename are treated as equal.

variableValuesIgnoreCase

boolean

Match all variable values provided in variableValues case-insensitively. If set to true variableValue and variablevalue are treated as equal.

variableScopeIdIn

string

Only include variable instances which belong to one of passed scope ids.

sortBy

enum<string>

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

Available options:

variableName,

variableType,

activityInstanceId,

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.

deserializeValues

boolean

Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default true).

If set to true, a serializable variable will be deserialized on server side and transformed to JSON using Jackson's POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath.

If set to false, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML.

Note: While true is the default value for reasons of backward compatibility, we recommend setting this parameter to false when developing web applications that are independent of the Java process applications deployed to the engine.

Response

Request successful.

string | null

The id of the variable instance.

name

string | null

The name of the variable instance.

processDefinitionId

string | null

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

processInstanceId

string | null

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

executionId

string | null

The id of the execution that this variable instance belongs to.

caseInstanceId

string | null

The id of the case instance that this variable instance belongs to.

caseExecutionId

string | null

The id of the case execution that this variable instance belongs to.

taskId

string | null

The id of the task that this variable instance belongs to.

batchId

string | null

The id of the batch that this variable instance belongs to.<

activityInstanceId

string | null

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

tenantId

string | null

The id of the tenant that this variable instance belongs to.

errorMessage

string | null

An error message in case a Java Serialized Object could not be de-serialized.

value

any

Can be any value - string, number, boolean, array or object. Note: Not every endpoint supports every type.

type

string | null

The value type of the variable.

valueInfo

object

A JSON object containing additional, value-type-dependent properties. For serialized variables of type Object, the following properties can be provided:

objectTypeName: A string representation of the object's type name.
serializationDataFormat: The serialization format used to store the variable.

For serialized variables of type File, the following properties can be provided:

filename: The name of the file. This is not the variable name but the name that will be used when downloading the file again.
mimetype: The MIME type of the file that is being uploaded.
encoding: The encoding of the file that is being uploaded.

The following property can be provided for all value types:

transient: Indicates whether the variable should be transient or not. See documentation for more informations. (Not applicable for decision-definition, /process-instance/variables-async, and /migration/executeAsync endpoints)

解锁用户获取列表(POST)

⌘I

REST API

Javadoc

Authorizations

Query Parameters

Response