{ "$schema": "http://json-schema.org/draft-07/schema#", "title": "Flowable BPMN API Schemas", "description": "JSON Schema definitions extracted from the Flowable BPMN OpenAPI specification", "definitions": { "ActivityInstanceQueryRequest": { "type": "object", "properties": { "start": { "type": "integer", "format": "int32" }, "size": { "type": "integer", "format": "int32" }, "sort": { "type": "string" }, "order": { "type": "string" }, "activityId": { "type": "string" }, "activityInstanceId": { "type": "string" }, "activityName": { "type": "string" }, "activityType": { "type": "string" }, "executionId": { "type": "string" }, "finished": { "type": "boolean" }, "taskAssignee": { "type": "string" }, "taskCompletedBy": { "type": "string" }, "processInstanceId": { "type": "string" }, "processInstanceIds": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "processDefinitionId": { "type": "string" }, "tenantId": { "type": "string" }, "tenantIdLike": { "type": "string" }, "withoutTenantId": { "type": "boolean" } } }, "ActivityInstanceQueryResource": { "type": "object" }, "ActivityInstanceResponse": { "type": "object", "properties": { "id": { "type": "string", "example": "5" }, "activityId": { "type": "string", "example": "4" }, "activityName": { "type": "string", "example": "My user task" }, "activityType": { "type": "string", "example": "userTask" }, "processDefinitionId": { "type": "string", "example": "oneTaskProcess%3A1%3A4" }, "processDefinitionUrl": { "type": "string", "example": "http://localhost:8182/repository/process-definitions/oneTaskProcess%3A1%3A4" }, "processInstanceId": { "type": "string", "example": "3" }, "processInstanceUrl": { "type": "string", "example": "http://localhost:8182/runtime/process-instances/3" }, "executionId": { "type": "string", "example": "4" }, "taskId": { "type": "string", "example": "4" }, "calledProcessInstanceId": { "type": "string", "example": "null" }, "assignee": { "type": "string", "example": "fozzie" }, "startTime": { "type": "string", "format": "date-time", "example": "2013-04-17T10:17:43.902+0000" }, "endTime": { "type": "string", "format": "date-time", "example": "2013-04-18T14:06:32.715+0000" }, "durationInMillis": { "type": "integer", "format": "int64", "example": 86400056 }, "tenantId": { "type": "string", "example": "null" } } }, "Artifact": { "type": "object", "properties": { "id": { "type": "string" }, "xmlRowNumber": { "type": "integer", "format": "int32" }, "xmlColumnNumber": { "type": "integer", "format": "int32" }, "extensionElements": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionElement" } } }, "attributes": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionAttribute" } } } } }, "AttachmentResponse": { "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": "string" }, "userId": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string", "description": "Can be any arbitrary value. When a valid formatted media-type (e.g. application/xml, text/plain) is included, the binary content HTTP response content-type will be set the given value." }, "taskUrl": { "type": "string" }, "processInstanceUrl": { "type": "string" }, "externalUrl": { "type": "string", "description": "contentUrl:In case the attachment is a link to an external resource, the externalUrl contains the URL to the external content. If the attachment content is present in the Flowable engine, the contentUrl will contain an URL where the binary content can be streamed from." }, "contentUrl": { "type": "string" }, "time": { "type": "string", "format": "date-time" } } }, "BaseElement": { "type": "object", "properties": { "id": { "type": "string" }, "xmlRowNumber": { "type": "integer", "format": "int32" }, "xmlColumnNumber": { "type": "integer", "format": "int32" }, "extensionElements": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionElement" } } }, "attributes": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionAttribute" } } } } }, "BatchPartResponse": { "type": "object", "properties": { "id": { "type": "string", "example": "8" }, "url": { "type": "string", "example": "http://localhost:8182/management/batch-parts/8" }, "batchId": { "type": "string", "example": "4" }, "batchUrl": { "type": "string", "example": "http://localhost:8182/management/batch/4" }, "batchType": { "type": "string", "example": "processMigration" }, "searchKey": { "type": "string", "example": "1:22:MP" }, "searchKey2": { "type": "string", "example": "1:24:MP" }, "scopeId": { "type": "string", "example": "1" }, "subScopeId": { "type": "string", "example": "2" }, "scopeType": { "type": "string", "example": "bpmn" }, "createTime": { "type": "string", "format": "date-time", "example": "2020-06-03T22:05:05.474+0000" }, "completeTime": { "type": "string", "format": "date-time", "example": "2020-06-03T22:05:05.474+0000" }, "status": { "type": "string", "example": "completed" }, "tenantId": { "type": "string", "example": "null" } } }, "BatchResponse": { "type": "object", "properties": { "id": { "type": "string", "example": "8" }, "url": { "type": "string", "example": "http://localhost:8182/management/batches/8" }, "batchType": { "type": "string", "example": "processMigration" }, "searchKey": { "type": "string", "example": "1:22:MP" }, "searchKey2": { "type": "string", "example": "1:24:MP" }, "createTime": { "type": "string", "format": "date-time", "example": "2020-06-03T22:05:05.474+0000" }, "completeTime": { "type": "string", "format": "date-time", "example": "2020-06-03T22:05:05.474+0000" }, "status": { "type": "string", "example": "completed" }, "tenantId": { "type": "string", "example": "null" } } }, "BpmnDiEdge": { "type": "object", "properties": { "sourceDockerInfo": { "$ref": "#/components/schemas/GraphicInfo" }, "targetDockerInfo": { "$ref": "#/components/schemas/GraphicInfo" }, "waypoints": { "type": "array", "items": { "$ref": "#/components/schemas/GraphicInfo" } } } }, "BpmnModel": { "type": "object", "properties": { "definitionsAttributes": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionAttribute" } } }, "processes": { "type": "array", "items": { "$ref": "#/components/schemas/Process" } }, "locationMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/GraphicInfo" } }, "labelLocationMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/GraphicInfo" } }, "flowLocationMap": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/GraphicInfo" } } }, "edgeMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/BpmnDiEdge" } }, "signals": { "type": "array", "items": { "$ref": "#/components/schemas/Signal" } }, "pools": { "type": "array", "items": { "$ref": "#/components/schemas/Pool" } }, "imports": { "type": "array", "items": { "$ref": "#/components/schemas/Import" } }, "interfaces": { "type": "array", "items": { "$ref": "#/components/schemas/Interface" } }, "globalArtifacts": { "type": "array", "items": { "$ref": "#/components/schemas/Artifact" } }, "resources": { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, "targetNamespace": { "type": "string" }, "sourceSystemId": { "type": "string" }, "userTaskFormTypes": { "type": "array", "items": { "type": "string" } }, "startEventFormTypes": { "type": "array", "items": { "type": "string" } }, "exporter": { "type": "string" }, "exporterVersion": { "type": "string" }, "mainProcess": { "$ref": "#/components/schemas/Process" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Message" } }, "errors": { "type": "object", "additionalProperties": { "type": "string" } }, "escalations": { "type": "array", "items": { "$ref": "#/components/schemas/Escalation" } }, "dataStores": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DataStore" } }, "namespaces": { "type": "object", "additionalProperties": { "type": "string" } }, "messageFlows": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/MessageFlow" } }, "itemDefinitions": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ItemDefinition" } } } }, "BulkDeleteInstancesRestActionRequest": { "type": "object", "properties": { "action": { "type": "string" }, "instanceIds": { "type": "array", "items": { "type": "string" } }, "deleteReason": { "type": "string" } } }, "BulkMoveDeadLetterActionRequest": { "type": "object", "properties": { "action": { "type": "string" }, "jobIds": { "type": "array", "items": { "type": "string" } } } }, "BulkTasksRequest": { "type": "object", "properties": { "owner": { "type": "string" }, "assignee": { "type": "string" }, "delegationState": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "dueDate": { "type": "string", "format": "date-time" }, "priority": { "type": "integer", "format": "int32" }, "parentTaskId": { "type": "string" }, "category": { "type": "string" }, "tenantId": { "type": "string" }, "formKey": { "type": "string" }, "ownerSet": { "type": "boolean" }, "assigneeSet": { "type": "boolean" }, "delegationStateSet": { "type": "boolean" }, "nameSet": { "type": "boolean" }, "descriptionSet": { "type": "boolean" }, "duedateSet": { "type": "boolean" }, "prioritySet": { "type": "boolean" }, "parentTaskIdSet": { "type": "boolean" }, "categorySet": { "type": "boolean" }, "tenantIdSet": { "type": "boolean" }, "formKeySet": { "type": "boolean" }, "taskIds": { "type": "array", "items": { "type": "string" } } } }, "CommentRequest": { "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "author": { "type": "string" }, "message": { "type": "string" }, "type": { "type": "string" }, "saveProcessInstanceId": { "type": "boolean" } } }, "CommentResponse": { "type": "object", "properties": { "id": { "type": "string" }, "author": { "type": "string" }, "message": { "type": "string" }, "time": { "type": "string", "format": "date-time" }, "taskId": { "type": "string" }, "taskUrl": { "type": "string" }, "processInstanceId": { "type": "string" }, "processInstanceUrl": { "type": "string" } } }, "DataResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "total": { "type": "integer", "format": "int64" }, "start": { "type": "integer", "format": "int32" }, "sort": { "type": "string" }, "order": { "type": "string" }, "size": { "type": "integer", "format": "int32" } } }, "DataResponseActivityInstanceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityInstanceResponse" } }, "total": { "type": "integer", "format": "int64" }, "start": { "type": "integer", "format": "int32" }, "sort": { "type": "string" }, "order": { "type": "string" }, "size": { "type": "integer", "format": "int32" } } }, "DataResponseBatchResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BatchResponse" } }, "total": { "type": "integer", "format": "int64" }, "start": { "type": "integer", "format": "int32" }, "sort": { "type": "string" }, "order": { "type": "string" }, "size": { "type": "integer", "format": "int32" } } }, "DataResponseDeploymentResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DeploymentResponse" } }, "total": { "type": "integer", "format": "int64" }, "start": { "type": "integer", "format": "int32" }, "sort": { "type": "string" }, "order": { "type": "string" }, "size": { "type": "integer", "format": "int32" } } }, "DataResponseEventSubscriptionResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/EventSubscriptionResponse" } }, "total": { "type": "integer", "format": "int64" }, "start": { "type": "integer", "format": "int32" }, "sort": { "type": "string" }, "order": { "type": "string" }, "size": { "type": "integer", "format": "int32" } } }, "DataResponseExecutionResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ExecutionResponse" } }, "total": { "type": "integer", "format": "int64" }, "start": { "type": "integer", "format": "int32" }, "sort": { "type": "string" }, "order": { "type": "string" }, "size": { "type": "integer", "format": "int32" } } }, "DataResponseGroupResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/GroupResponse" } }, "total": { "type": "integer", "format": "int64" }, "start": { "type": "integer", "format": "int32" }, "sort": { "type": "string" }, "order": { "type": "string" }, "size": { "type": "integer", "format": "int32" } } }, "DataResponseHistoricActivityInstanceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/HistoricActivityInstanceResponse" } }, "total": { "type": "integer", "format": "int64" }, "start": { "type": "integer", "format": "int32" }, "sort": { "type": "string" }, "order": { "type": "string" }, "size": { "type": "integer", "format": "int32" } } }, "DataResponseHistoricDetailResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/HistoricDetailResponse" } }, "total": { "type": "integer", "format": "int64" }, "start": { "type": "integer", "format": "int32" }, "sort": { "type": "string" }, "order": { "type": "string" }, "size": { "type": "integer", "format": "int32" } } }, "DataResponseHistoricProcessInstanceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/HistoricProcessInstanceResponse" } }, "total": { "type": "integer", "format": "int64" }, "start": { "type": "integer", "format": "int32" }, "sort": { "type": "string" }, "order": { "type": "string" }, "size": { "type": "integer", "format": "int32" } } }, "DataResponseHistoricTaskInstanceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/HistoricTaskInstanceResponse" } }, "total": { "type": "integer", "format": "int64" }, "start": { "type": "integer", "format": "int32" }, "sort": { "type": "string" }, "order": { "type": "string" }, "size": { "type": "integer", "format": "int32" } } }, "DataResponseHistoricTaskLogEntryResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/HistoricTaskLogEntryResponse" } }, "total": { "type": "integer", "format": "int64" }, "start": { "type": "integer", "format": "int32" }, "sort": { "type": "string" }, "order": { "type": "string" }, "size": { "type": "integer", "format": "int32" } } }, "DataResponseHistoricVariableInstanceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/HistoricVariableInstanceResponse" } }, "total": { "type": "integer", "format": "int64" }, "start": { "type": "integer", "format": "int32" }, "sort": { "type": "string" }, "order": { "type": "string" }, "size": { "type": "integer", "format": "int32" } } }, "DataResponseHistoryJobResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/HistoryJobResponse" } }, "total": { "type": "integer", "format": "int64" }, "start": { "type": "integer", "format": "int32" }, "sort": { "type": "string" }, "order": { "type": "string" }, "size": { "type": "integer", "format": "int32" } } }, "DataResponseJobResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/JobResponse" } }, "total": { "type": "integer", "format": "int64" }, "start": { "type": "integer", "format": "int32" }, "sort": { "type": "string" }, "order": { "type": "string" }, "size": { "type": "integer", "format": "int32" } } }, "DataResponseListMapStringObject": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } } }, "total": { "type": "integer", "format": "int64" }, "start": { "type": "integer", "format": "int32" }, "sort": { "type": "string" }, "order": { "type": "string" }, "size": { "type": "integer", "format": "int32" } } }, "DataResponseModelResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ModelResponse" } }, "total": { "type": "integer", "format": "int64" }, "start": { "type": "integer", "format": "int32" }, "sort": { "type": "string" }, "order": { "type": "string" }, "size": { "type": "integer", "format": "int32" } } }, "DataResponseProcessDefinitionResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessDefinitionResponse" } }, "total": { "type": "integer", "format": "int64" }, "start": { "type": "integer", "format": "int32" }, "sort": { "type": "string" }, "order": { "type": "string" }, "size": { "type": "integer", "format": "int32" } } }, "DataResponseProcessInstanceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessInstanceResponse" } }, "total": { "type": "integer", "format": "int64" }, "start": { "type": "integer", "format": "int32" }, "sort": { "type": "string" }, "order": { "type": "string" }, "size": { "type": "integer", "format": "int32" } } }, "DataResponseTaskResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TaskResponse" } }, "total": { "type": "integer", "format": "int64" }, "start": { "type": "integer", "format": "int32" }, "sort": { "type": "string" }, "order": { "type": "string" }, "size": { "type": "integer", "format": "int32" } } }, "DataResponseUserResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/UserResponse" } }, "total": { "type": "integer", "format": "int64" }, "start": { "type": "integer", "format": "int32" }, "sort": { "type": "string" }, "order": { "type": "string" }, "size": { "type": "integer", "format": "int32" } } }, "DataResponseVariableInstanceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/VariableInstanceResponse" } }, "total": { "type": "integer", "format": "int64" }, "start": { "type": "integer", "format": "int32" }, "sort": { "type": "string" }, "order": { "type": "string" }, "size": { "type": "integer", "format": "int32" } } }, "DataSpec": { "type": "object", "properties": { "id": { "type": "string" }, "xmlRowNumber": { "type": "integer", "format": "int32" }, "xmlColumnNumber": { "type": "integer", "format": "int32" }, "extensionElements": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionElement" } } }, "attributes": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionAttribute" } } }, "name": { "type": "string" }, "itemSubjectRef": { "type": "string" }, "collection": { "type": "boolean" } } }, "DataStore": { "type": "object", "properties": { "id": { "type": "string" }, "xmlRowNumber": { "type": "integer", "format": "int32" }, "xmlColumnNumber": { "type": "integer", "format": "int32" }, "extensionElements": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionElement" } } }, "attributes": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionAttribute" } } }, "name": { "type": "string" }, "dataState": { "type": "string" }, "itemSubjectRef": { "type": "string" } } }, "DecisionResponse": { "type": "object", "properties": { "id": { "type": "string" }, "category": { "type": "string" }, "name": { "type": "string" }, "key": { "type": "string" }, "description": { "type": "string" }, "version": { "type": "integer", "format": "int32" }, "resourceName": { "type": "string" }, "deploymentId": { "type": "string" }, "tenantId": { "type": "string" }, "url": { "type": "string" } } }, "DeploymentResourceResponse": { "type": "object", "properties": { "id": { "type": "string", "example": "diagrams/my-process.bpmn20.xml" }, "url": { "type": "string", "example": "http://localhost:8081/flowable-rest/service/repository/deployments/10/resources/diagrams%2Fmy-process.bpmn20.xml", "description": "For a single resource contains the actual URL to use for retrieving the binary resource" }, "contentUrl": { "type": "string", "example": "http://localhost:8081/flowable-rest/service/repository/deployments/10/resourcedata/diagrams%2Fmy-process.bpmn20.xml" }, "mediaType": { "type": "string", "example": "text/xml", "description": "Contains the media-type the resource has. This is resolved using a (pluggable) MediaTypeResolver and contains, by default, a limited number of mime-type mappings." }, "type": { "type": "string", "example": "processDefinition", "description": "Type of resource", "enum": [ "resource", "processDefinition", "processImage" ] } } }, "DeploymentResponse": { "type": "object", "properties": { "id": { "type": "string", "example": "10" }, "name": { "type": "string", "example": "flowable-examples.bar" }, "deploymentTime": { "type": "string", "format": "date-time", "example": "2010-10-13T14:54:26.750+02:00" }, "category": { "type": "string", "example": "examples" }, "parentDeploymentId": { "type": "string", "example": "12" }, "url": { "type": "string", "example": "http://localhost:8081/flowable-rest/service/repository/deployments/10" }, "tenantId": { "type": "string" } } }, "EngineInfoResponse": { "type": "object", "properties": { "name": { "type": "string", "example": "default" }, "resourceUrl": { "type": "string", "example": "file://flowable/flowable.cfg.xml" }, "exception": { "type": "string", "example": "null" }, "version": { "type": "string", "example": "6.3.1" } } }, "Escalation": { "type": "object", "properties": { "id": { "type": "string" }, "xmlRowNumber": { "type": "integer", "format": "int32" }, "xmlColumnNumber": { "type": "integer", "format": "int32" }, "extensionElements": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionElement" } } }, "attributes": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionAttribute" } } }, "name": { "type": "string" }, "escalationCode": { "type": "string" } } }, "EventListener": { "type": "object", "properties": { "id": { "type": "string" }, "xmlRowNumber": { "type": "integer", "format": "int32" }, "xmlColumnNumber": { "type": "integer", "format": "int32" }, "extensionElements": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionElement" } } }, "attributes": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionAttribute" } } }, "events": { "type": "string" }, "implementationType": { "type": "string" }, "implementation": { "type": "string" }, "entityType": { "type": "string" }, "onTransaction": { "type": "string" } } }, "EventResponse": { "type": "object", "properties": { "url": { "type": "string" }, "id": { "type": "string" }, "action": { "type": "string" }, "userId": { "type": "string" }, "time": { "type": "string", "format": "date-time" }, "taskUrl": { "type": "string" }, "processInstanceUrl": { "type": "string" }, "message": { "type": "array", "items": { "type": "string" } } } }, "EventSubscriptionResponse": { "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "eventType": { "type": "string" }, "eventName": { "type": "string" }, "activityId": { "type": "string" }, "executionId": { "type": "string" }, "executionUrl": { "type": "string" }, "processInstanceId": { "type": "string" }, "processInstanceUrl": { "type": "string" }, "processDefinitionId": { "type": "string" }, "processDefinitionUrl": { "type": "string" }, "scopeId": { "type": "string" }, "scopeType": { "type": "string" }, "subScopeId": { "type": "string" }, "scopeDefinitionId": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "configuration": { "type": "string" }, "tenantId": { "type": "string" } } }, "ExecutionActionRequest": { "type": "object", "required": [ "action" ], "properties": { "action": { "type": "string", "example": "signalEventReceived", "description": "Action to perform: Either signal, trigger, signalEventReceived or messageEventReceived" }, "signalName": { "type": "string", "example": "My Signal", "description": "Name of the signal" }, "messageName": { "type": "string", "example": "My Signal", "description": "Message of the signal" }, "variables": { "type": "array", "items": { "$ref": "#/components/schemas/RestVariable" } }, "transientVariables": { "type": "array", "items": { "$ref": "#/components/schemas/RestVariable" } } } }, "ExecutionChangeActivityStateRequest": { "type": "object", "properties": { "cancelActivityIds": { "type": "array", "description": "activityIds to be canceled", "items": { "type": "string" } }, "startActivityIds": { "type": "array", "description": "activityIds to be started", "items": { "type": "string" } } } }, "ExecutionQueryRequest": { "type": "object", "properties": { "start": { "type": "integer", "format": "int32" }, "size": { "type": "integer", "format": "int32" }, "sort": { "type": "string" }, "order": { "type": "string" }, "id": { "type": "string" }, "activityId": { "type": "string" }, "parentId": { "type": "string" }, "processInstanceId": { "type": "string" }, "processInstanceIds": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "processBusinessKey": { "type": "string" }, "processDefinitionId": { "type": "string" }, "processDefinitionKey": { "type": "string" }, "signalEventSubscriptionName": { "type": "string" }, "messageEventSubscriptionName": { "type": "string" }, "variables": { "type": "array", "items": { "$ref": "#/components/schemas/QueryVariable" } }, "processInstanceVariables": { "type": "array", "items": { "$ref": "#/components/schemas/QueryVariable" } }, "tenantId": { "type": "string" }, "tenantIdLike": { "type": "string" }, "withoutTenantId": { "type": "boolean" } } }, "ExecutionQueryResource": { "type": "object" }, "ExecutionResponse": { "type": "object", "properties": { "id": { "type": "string", "example": "5" }, "url": { "type": "string", "example": "http://localhost:8182/runtime/executions/5" }, "parentId": { "type": "string", "example": "null" }, "parentUrl": { "type": "string", "example": "null" }, "superExecutionId": { "type": "string", "example": "null" }, "superExecutionUrl": { "type": "string", "example": "null" }, "processInstanceId": { "type": "string", "example": "5" }, "processInstanceUrl": { "type": "string", "example": "http://localhost:8182/runtime/process-instances/5" }, "suspended": { "type": "boolean" }, "activityId": { "type": "string", "example": "null" }, "tenantId": { "type": "string", "example": "null" } } }, "ExecutionVariableCollectionResource": { "type": "object" }, "ExecutionVariableResource": { "type": "object" }, "ExtensionAttribute": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "namespacePrefix": { "type": "string" }, "namespace": { "type": "string" } } }, "ExtensionElement": { "type": "object", "properties": { "id": { "type": "string" }, "xmlRowNumber": { "type": "integer", "format": "int32" }, "xmlColumnNumber": { "type": "integer", "format": "int32" }, "extensionElements": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionElement" } } }, "attributes": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionAttribute" } } }, "name": { "type": "string" }, "namespacePrefix": { "type": "string" }, "namespace": { "type": "string" }, "elementText": { "type": "string" }, "childElements": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionElement" } } } } }, "FieldExtension": { "type": "object", "properties": { "id": { "type": "string" }, "xmlRowNumber": { "type": "integer", "format": "int32" }, "xmlColumnNumber": { "type": "integer", "format": "int32" }, "extensionElements": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionElement" } } }, "attributes": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionAttribute" } } }, "fieldName": { "type": "string" }, "stringValue": { "type": "string" }, "expression": { "type": "string" } } }, "FlowElement": { "type": "object", "properties": { "id": { "type": "string" }, "xmlRowNumber": { "type": "integer", "format": "int32" }, "xmlColumnNumber": { "type": "integer", "format": "int32" }, "extensionElements": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionElement" } } }, "attributes": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionAttribute" } } }, "name": { "type": "string" }, "documentation": { "type": "string" }, "executionListeners": { "type": "array", "items": { "$ref": "#/components/schemas/FlowableListener" } } } }, "FlowableListener": { "type": "object", "properties": { "id": { "type": "string" }, "xmlRowNumber": { "type": "integer", "format": "int32" }, "xmlColumnNumber": { "type": "integer", "format": "int32" }, "extensionElements": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionElement" } } }, "attributes": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionAttribute" } } }, "event": { "type": "string" }, "implementationType": { "type": "string" }, "implementation": { "type": "string" }, "fieldExtensions": { "type": "array", "items": { "$ref": "#/components/schemas/FieldExtension" } }, "onTransaction": { "type": "string" }, "customPropertiesResolverImplementationType": { "type": "string" }, "customPropertiesResolverImplementation": { "type": "string" }, "scriptInfo": { "$ref": "#/components/schemas/ScriptInfo" } } }, "FormDataResponse": { "type": "object", "properties": { "formKey": { "type": "string", "example": "null" }, "deploymentId": { "type": "string", "example": "2" }, "processDefinitionId": { "type": "string", "example": "3" }, "processDefinitionUrl": { "type": "string", "example": "http://localhost:8182/repository/process-definition/3" }, "taskId": { "type": "string", "example": "6" }, "taskUrl": { "type": "string", "example": "http://localhost:8182/runtime/task/6" }, "formProperties": { "type": "array", "items": { "$ref": "#/components/schemas/RestFormProperty" } } } }, "FormDefinitionResponse": { "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "category": { "type": "string" }, "name": { "type": "string" }, "key": { "type": "string" }, "description": { "type": "string" }, "version": { "type": "integer", "format": "int32" }, "resourceName": { "type": "string" }, "deploymentId": { "type": "string" }, "tenantId": { "type": "string" } } }, "GraphicInfo": { "type": "object", "properties": { "x": { "type": "number", "format": "double" }, "y": { "type": "number", "format": "double" }, "height": { "type": "number", "format": "double" }, "width": { "type": "number", "format": "double" }, "element": { "$ref": "#/components/schemas/BaseElement" }, "expanded": { "type": "boolean" }, "xmlRowNumber": { "type": "integer", "format": "int32" }, "xmlColumnNumber": { "type": "integer", "format": "int32" }, "rotation": { "type": "number", "format": "double" } } }, "GroupRequest": { "type": "object", "properties": { "id": { "type": "string", "example": "testgroup" }, "url": { "type": "string", "example": "http://localhost:8182/identity/groups/testgroup" }, "name": { "type": "string", "example": "Test group" }, "type": { "type": "string", "example": "Test type" }, "nameChanged": { "type": "boolean" }, "typeChanged": { "type": "boolean" } } }, "GroupResponse": { "type": "object", "properties": { "id": { "type": "string", "example": "testgroup" }, "url": { "type": "string", "example": "http://localhost:8182/identity/groups/testgroup" }, "name": { "type": "string", "example": "Test group" }, "type": { "type": "string", "example": "Test type" } } }, "HistoricActivityInstanceQueryRequest": { "type": "object", "properties": { "start": { "type": "integer", "format": "int32" }, "size": { "type": "integer", "format": "int32" }, "sort": { "type": "string" }, "order": { "type": "string" }, "activityId": { "type": "string" }, "activityInstanceId": { "type": "string" }, "activityName": { "type": "string" }, "activityType": { "type": "string" }, "executionId": { "type": "string" }, "finished": { "type": "boolean" }, "taskAssignee": { "type": "string" }, "processInstanceId": { "type": "string" }, "processInstanceIds": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "processDefinitionId": { "type": "string" }, "calledProcessInstanceIds": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "tenantId": { "type": "string" }, "tenantIdLike": { "type": "string" }, "withoutTenantId": { "type": "boolean" } } }, "HistoricActivityInstanceQueryResource": { "type": "object" }, "HistoricActivityInstanceResponse": { "type": "object", "properties": { "id": { "type": "string", "example": "5" }, "activityId": { "type": "string", "example": "4" }, "activityName": { "type": "string", "example": "My user task" }, "activityType": { "type": "string", "example": "userTask" }, "processDefinitionId": { "type": "string", "example": "oneTaskProcess%3A1%3A4" }, "processDefinitionUrl": { "type": "string", "example": "http://localhost:8182/repository/process-definitions/oneTaskProcess%3A1%3A4" }, "processInstanceId": { "type": "string", "example": "3" }, "processInstanceUrl": { "type": "string", "example": "http://localhost:8182/history/historic-process-instances/3" }, "executionId": { "type": "string", "example": "4" }, "taskId": { "type": "string", "example": "4" }, "calledProcessInstanceId": { "type": "string", "example": "null" }, "assignee": { "type": "string", "example": "fozzie" }, "startTime": { "type": "string", "format": "date-time", "example": "2013-04-17T10:17:43.902+0000" }, "endTime": { "type": "string", "format": "date-time", "example": "2013-04-18T14:06:32.715+0000" }, "durationInMillis": { "type": "integer", "format": "int64", "example": 86400056 }, "tenantId": { "type": "string", "example": "null" } } }, "HistoricDetailQueryRequest": { "type": "object", "properties": { "start": { "type": "integer", "format": "int32" }, "size": { "type": "integer", "format": "int32" }, "sort": { "type": "string" }, "order": { "type": "string" }, "id": { "type": "string" }, "processInstanceId": { "type": "string" }, "executionId": { "type": "string" }, "activityInstanceId": { "type": "string" }, "taskId": { "type": "string" }, "selectOnlyFormProperties": { "type": "boolean" }, "selectOnlyVariableUpdates": { "type": "boolean" } } }, "HistoricDetailQueryResource": { "type": "object" }, "HistoricDetailResponse": { "type": "object", "properties": { "id": { "type": "string", "example": "26" }, "processInstanceId": { "type": "string", "example": "5" }, "processInstanceUrl": { "type": "string", "example": "http://localhost:8182/history/historic-process-instances/5" }, "executionId": { "type": "string", "example": "6" }, "activityInstanceId": { "type": "string", "example": "10" }, "taskId": { "type": "string", "example": "6" }, "taskUrl": { "type": "string", "example": "http://localhost:8182/history/historic-task-instances/6" }, "time": { "type": "string", "format": "date-time", "example": "2013-04-17T10:17:43.902+0000" }, "detailType": { "type": "string", "example": "variableUpdate" }, "revision": { "type": "integer", "format": "int32", "example": 2 }, "variable": { "$ref": "#/components/schemas/RestVariable" }, "propertyId": { "type": "string", "example": "null" }, "propertyValue": { "type": "string", "example": "null" } } }, "HistoricIdentityLinkResponse": { "type": "object", "properties": { "type": { "type": "string", "example": "participant" }, "userId": { "type": "string", "example": "kermit" }, "groupId": { "type": "string", "example": "sales" }, "taskId": { "type": "string", "example": "null" }, "taskUrl": { "type": "string", "example": "null" }, "processInstanceId": { "type": "string", "example": "5" }, "processInstanceUrl": { "type": "string", "example": "http://localhost:8182/history/historic-process-instances/5" } } }, "HistoricProcessInstanceQueryRequest": { "type": "object", "properties": { "start": { "type": "integer", "format": "int32" }, "size": { "type": "integer", "format": "int32" }, "sort": { "type": "string" }, "order": { "type": "string" }, "processInstanceId": { "type": "string" }, "processInstanceIds": { "type": "array", "items": { "type": "string" } }, "processInstanceName": { "type": "string" }, "processInstanceNameLike": { "type": "string" }, "processInstanceNameLikeIgnoreCase": { "type": "string" }, "processBusinessKey": { "type": "string" }, "processBusinessKeyLike": { "type": "string" }, "processBusinessKeyLikeIgnoreCase": { "type": "string" }, "processBusinessStatus": { "type": "string" }, "processBusinessStatusLike": { "type": "string" }, "processBusinessStatusLikeIgnoreCase": { "type": "string" }, "processDefinitionId": { "type": "string" }, "processDefinitionKey": { "type": "string" }, "processDefinitionKeyLike": { "type": "string" }, "processDefinitionKeyLikeIgnoreCase": { "type": "string" }, "processDefinitionKeys": { "type": "array", "items": { "type": "string" } }, "excludeProcessDefinitionKeys": { "type": "array", "items": { "type": "string" } }, "processDefinitionKeyIn": { "type": "array", "items": { "type": "string" } }, "processDefinitionKeyNotIn": { "type": "array", "items": { "type": "string" } }, "processDefinitionName": { "type": "string" }, "processDefinitionNameLike": { "type": "string" }, "processDefinitionNameLikeIgnoreCase": { "type": "string" }, "processDefinitionVersion": { "type": "integer", "format": "int32" }, "processDefinitionCategory": { "type": "string" }, "processDefinitionCategoryLike": { "type": "string" }, "processDefinitionCategoryLikeIgnoreCase": { "type": "string" }, "deploymentId": { "type": "string" }, "deploymentIdIn": { "type": "array", "items": { "type": "string" } }, "superProcessInstanceId": { "type": "string" }, "excludeSubprocesses": { "type": "boolean" }, "finished": { "type": "boolean" }, "activeActivityId": { "type": "string" }, "activeActivityIds": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "involvedUser": { "type": "string" }, "finishedAfter": { "type": "string", "format": "date-time" }, "finishedBefore": { "type": "string", "format": "date-time" }, "startedAfter": { "type": "string", "format": "date-time" }, "startedBefore": { "type": "string", "format": "date-time" }, "startedBy": { "type": "string" }, "finishedBy": { "type": "string" }, "state": { "type": "string" }, "includeProcessVariables": { "type": "boolean" }, "includeProcessVariablesNames": { "type": "array", "items": { "type": "string" } }, "variables": { "type": "array", "items": { "$ref": "#/components/schemas/QueryVariable" } }, "callbackId": { "type": "string" }, "callbackIds": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "callbackType": { "type": "string" }, "parentCaseInstanceId": { "type": "string" }, "withoutCallbackId": { "type": "boolean" }, "tenantId": { "type": "string" }, "tenantIdLike": { "type": "string" }, "tenantIdLikeIgnoreCase": { "type": "string" }, "withoutTenantId": { "type": "boolean" }, "rootScopeId": { "type": "string" }, "parentScopeId": { "type": "string" } } }, "HistoricProcessInstanceQueryResource": { "type": "object" }, "HistoricProcessInstanceResponse": { "type": "object", "properties": { "id": { "type": "string", "example": "5" }, "url": { "type": "string", "example": "http://localhost:8182/history/historic-process-instances/5" }, "name": { "type": "string", "example": "myProcessInstanceName" }, "businessKey": { "type": "string", "example": "myKey" }, "businessStatus": { "type": "string", "example": "myStatus" }, "processDefinitionId": { "type": "string", "example": "oneTaskProcess%3A1%3A4" }, "processDefinitionUrl": { "type": "string", "example": "http://localhost:8182/repository/process-definitions/oneTaskProcess%3A1%3A4" }, "processDefinitionName": { "type": "string", "example": "A process definition name" }, "processDefinitionDescription": { "type": "string", "example": "A process definition description" }, "startTime": { "type": "string", "format": "date-time", "example": "2013-04-17T10:17:43.902+0000" }, "endTime": { "type": "string", "format": "date-time", "example": "2013-04-18T14:06:32.715+0000" }, "durationInMillis": { "type": "integer", "format": "int64", "example": 86400056 }, "startUserId": { "type": "string", "example": "kermit" }, "endUserId": { "type": "string", "example": "kermit" }, "state": { "type": "string", "example": "running" }, "startActivityId": { "type": "string", "example": "startEvent" }, "endActivityId": { "type": "string", "example": "endEvent" }, "deleteReason": { "type": "string", "example": "null" }, "superProcessInstanceId": { "type": "string", "example": "3" }, "variables": { "type": "array", "items": { "$ref": "#/components/schemas/RestVariable" } }, "callbackId": { "type": "string", "example": "3" }, "callbackType": { "type": "string", "example": "cmmn" }, "referenceId": { "type": "string", "example": "123" }, "referenceType": { "type": "string", "example": "event-to-bpmn-2.0-process" }, "propagatedStageInstanceId": { "type": "string", "description": "The stage plan item instance id this process instance belongs to or null, if it is not part of a case at all or is not a child element of a stage" }, "tenantId": { "type": "string", "example": "someTenantId" } } }, "HistoricTaskInstanceQueryRequest": { "type": "object", "properties": { "start": { "type": "integer", "format": "int32" }, "size": { "type": "integer", "format": "int32" }, "sort": { "type": "string" }, "order": { "type": "string" }, "taskId": { "type": "string" }, "processInstanceId": { "type": "string" }, "processInstanceIdWithChildren": { "type": "string" }, "withoutProcessInstanceId": { "type": "boolean" }, "processBusinessKey": { "type": "string" }, "processBusinessKeyLike": { "type": "string" }, "processDefinitionId": { "type": "string" }, "processDefinitionKey": { "type": "string" }, "processDefinitionKeyLike": { "type": "string" }, "processDefinitionName": { "type": "string" }, "processDefinitionNameLike": { "type": "string" }, "executionId": { "type": "string" }, "taskName": { "type": "string" }, "taskNameLike": { "type": "string" }, "taskNameLikeIgnoreCase": { "type": "string" }, "taskDescription": { "type": "string" }, "taskDescriptionLike": { "type": "string" }, "taskDefinitionKey": { "type": "string" }, "taskDefinitionKeyLike": { "type": "string" }, "taskDefinitionKeys": { "type": "array", "items": { "type": "string" } }, "taskCategory": { "type": "string" }, "taskCategoryIn": { "type": "array", "items": { "type": "string" } }, "taskCategoryNotIn": { "type": "array", "items": { "type": "string" } }, "taskWithoutCategory": { "type": "boolean" }, "taskDeleteReason": { "type": "string" }, "taskDeleteReasonLike": { "type": "string" }, "taskAssignee": { "type": "string" }, "taskAssigneeLike": { "type": "string" }, "taskOwner": { "type": "string" }, "taskOwnerLike": { "type": "string" }, "taskInvolvedUser": { "type": "string" }, "taskPriority": { "type": "integer", "format": "int32" }, "taskMinPriority": { "type": "integer", "format": "int32" }, "taskMaxPriority": { "type": "integer", "format": "int32" }, "finished": { "type": "boolean" }, "processFinished": { "type": "boolean" }, "parentTaskId": { "type": "string" }, "dueDate": { "type": "string", "format": "date-time" }, "dueDateAfter": { "type": "string", "format": "date-time" }, "dueDateBefore": { "type": "string", "format": "date-time" }, "withoutDueDate": { "type": "boolean" }, "taskCreatedOn": { "type": "string", "format": "date-time" }, "taskCreatedBefore": { "type": "string", "format": "date-time" }, "taskCreatedAfter": { "type": "string", "format": "date-time" }, "taskCompletedOn": { "type": "string", "format": "date-time" }, "taskCompletedBefore": { "type": "string", "format": "date-time" }, "taskCompletedAfter": { "type": "string", "format": "date-time" }, "includeTaskLocalVariables": { "type": "boolean" }, "includeProcessVariables": { "type": "boolean" }, "taskVariables": { "type": "array", "items": { "$ref": "#/components/schemas/QueryVariable" } }, "processVariables": { "type": "array", "items": { "$ref": "#/components/schemas/QueryVariable" } }, "scopeDefinitionId": { "type": "string" }, "scopeId": { "type": "string" }, "scopeIds": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "withoutScopeId": { "type": "boolean" }, "scopeType": { "type": "string" }, "propagatedStageInstanceId": { "type": "string" }, "tenantId": { "type": "string" }, "tenantIdLike": { "type": "string" }, "withoutTenantId": { "type": "boolean" }, "withoutDeleteReason": { "type": "boolean" }, "taskCandidateGroup": { "type": "string" }, "ignoreTaskAssignee": { "type": "boolean" }, "rootScopeId": { "type": "string" }, "parentScopeId": { "type": "string" } } }, "HistoricTaskInstanceQueryResource": { "type": "object" }, "HistoricTaskInstanceResponse": { "type": "object", "properties": { "id": { "type": "string" }, "processDefinitionId": { "type": "string" }, "processDefinitionUrl": { "type": "string" }, "processInstanceId": { "type": "string" }, "processInstanceUrl": { "type": "string" }, "executionId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "deleteReason": { "type": "string" }, "owner": { "type": "string" }, "assignee": { "type": "string" }, "startTime": { "type": "string", "format": "date-time" }, "endTime": { "type": "string", "format": "date-time" }, "durationInMillis": { "type": "integer", "format": "int64" }, "workTimeInMillis": { "type": "integer", "format": "int64" }, "claimTime": { "type": "string", "format": "date-time" }, "taskDefinitionKey": { "type": "string" }, "formKey": { "type": "string" }, "priority": { "type": "integer", "format": "int32" }, "dueDate": { "type": "string", "format": "date-time" }, "parentTaskId": { "type": "string" }, "url": { "type": "string" }, "variables": { "type": "array", "items": { "$ref": "#/components/schemas/RestVariable" } }, "scopeDefinitionId": { "type": "string" }, "scopeId": { "type": "string" }, "subScopeId": { "type": "string" }, "scopeType": { "type": "string" }, "propagatedStageInstanceId": { "type": "string" }, "tenantId": { "type": "string" }, "category": { "type": "string" } } }, "HistoricTaskLogEntryResponse": { "type": "object", "properties": { "logNumber": { "type": "integer", "format": "int64" }, "type": { "type": "string" }, "taskId": { "type": "string" }, "timeStamp": { "type": "string", "format": "date-time" }, "userId": { "type": "string" }, "data": { "type": "string" }, "executionId": { "type": "string" }, "processInstanceId": { "type": "string" }, "processDefinitionId": { "type": "string" }, "scopeId": { "type": "string" }, "scopeDefinitionId": { "type": "string" }, "subScopeId": { "type": "string" }, "scopeType": { "type": "string" }, "tenantId": { "type": "string" } } }, "HistoricVariableInstanceCollectionResource": { "type": "object" }, "HistoricVariableInstanceQueryRequest": { "type": "object", "properties": { "start": { "type": "integer", "format": "int32" }, "size": { "type": "integer", "format": "int32" }, "sort": { "type": "string" }, "order": { "type": "string" }, "excludeTaskVariables": { "type": "boolean" }, "taskId": { "type": "string" }, "executionId": { "type": "string" }, "processInstanceId": { "type": "string" }, "variableName": { "type": "string" }, "variableNameLike": { "type": "string" }, "variables": { "type": "array", "items": { "$ref": "#/components/schemas/QueryVariable" } }, "excludeLocalVariables": { "type": "boolean" } } }, "HistoricVariableInstanceQueryResource": { "type": "object" }, "HistoricVariableInstanceResponse": { "type": "object", "properties": { "id": { "type": "string", "example": "14" }, "processInstanceId": { "type": "string", "example": "5" }, "processInstanceUrl": { "type": "string", "example": "http://localhost:8182/history/historic-process-instances/5" }, "taskId": { "type": "string", "example": "6" }, "executionId": { "type": "string" }, "variable": { "$ref": "#/components/schemas/RestVariable" } } }, "HistoryJobResponse": { "type": "object", "properties": { "id": { "type": "string", "example": "8" }, "url": { "type": "string", "example": "http://localhost:8182/management/jobs/8" }, "scopeType": { "type": "string", "example": "cmmn" }, "retries": { "type": "integer", "format": "int32", "example": 3 }, "exceptionMessage": { "type": "string", "example": "null" }, "jobHandlerType": { "type": "string", "example": "async-history" }, "jobHandlerConfiguration": { "type": "string", "example": "myCfg" }, "advancedJobHandlerConfiguration": { "type": "string", "example": "myAdvancedCfg" }, "tenantId": { "type": "string", "example": "null" }, "customValues": { "type": "string", "example": "custom value" }, "createTime": { "type": "string", "format": "date-time", "example": "2013-06-03T22:05:05.474+0000" }, "lockOwner": { "type": "string", "example": "node1" }, "lockExpirationTime": { "type": "string", "format": "date-time", "example": "2023-06-03T22:05:05.474+0000" } } }, "IOSpecification": { "type": "object", "properties": { "id": { "type": "string" }, "xmlRowNumber": { "type": "integer", "format": "int32" }, "xmlColumnNumber": { "type": "integer", "format": "int32" }, "extensionElements": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionElement" } } }, "attributes": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionAttribute" } } }, "dataInputs": { "type": "array", "items": { "$ref": "#/components/schemas/DataSpec" } }, "dataOutputs": { "type": "array", "items": { "$ref": "#/components/schemas/DataSpec" } }, "dataInputRefs": { "type": "array", "items": { "type": "string" } }, "dataOutputRefs": { "type": "array", "items": { "type": "string" } } } }, "Import": { "type": "object", "properties": { "id": { "type": "string" }, "xmlRowNumber": { "type": "integer", "format": "int32" }, "xmlColumnNumber": { "type": "integer", "format": "int32" }, "extensionElements": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionElement" } } }, "attributes": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionAttribute" } } }, "importType": { "type": "string" }, "location": { "type": "string" }, "namespace": { "type": "string" } } }, "InjectActivityRequest": { "type": "object", "properties": { "injectionType": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "assignee": { "type": "string" }, "taskId": { "type": "string" }, "processDefinitionId": { "type": "string" }, "joinParallelActivitiesOnComplete": { "type": "boolean" } } }, "Interface": { "type": "object", "properties": { "id": { "type": "string" }, "xmlRowNumber": { "type": "integer", "format": "int32" }, "xmlColumnNumber": { "type": "integer", "format": "int32" }, "extensionElements": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionElement" } } }, "attributes": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionAttribute" } } }, "name": { "type": "string" }, "implementationRef": { "type": "string" }, "operations": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } }, "ItemDefinition": { "type": "object", "properties": { "id": { "type": "string" }, "xmlRowNumber": { "type": "integer", "format": "int32" }, "xmlColumnNumber": { "type": "integer", "format": "int32" }, "extensionElements": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionElement" } } }, "attributes": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionAttribute" } } }, "structureRef": { "type": "string" }, "itemKind": { "type": "string" } } }, "JobResponse": { "type": "object", "properties": { "id": { "type": "string", "example": "8" }, "url": { "type": "string", "example": "http://localhost:8182/management/jobs/8" }, "correlationId": { "type": "string", "example": "50" }, "processInstanceId": { "type": "string", "example": "5" }, "processInstanceUrl": { "type": "string", "example": "http://localhost:8182/runtime/process-instances/5" }, "processDefinitionId": { "type": "string", "example": "timerProcess:1:4" }, "processDefinitionUrl": { "type": "string", "example": "http://localhost:8182/repository/process-definitions/timerProcess%3A1%3A4" }, "executionId": { "type": "string", "example": "7" }, "executionUrl": { "type": "string", "example": "http://localhost:8182/runtime/executions/7" }, "elementId": { "type": "string", "example": "timer" }, "elementName": { "type": "string", "example": "Timer task" }, "handlerType": { "type": "string", "example": "trigger-timer" }, "retries": { "type": "integer", "format": "int32", "example": 3 }, "exceptionMessage": { "type": "string", "example": "null" }, "dueDate": { "type": "string", "format": "date-time", "example": "2023-06-04T22:05:05.474+0000" }, "createTime": { "type": "string", "format": "date-time", "example": "2023-06-03T22:05:05.474+0000" }, "lockOwner": { "type": "string", "example": "node1" }, "lockExpirationTime": { "type": "string", "format": "date-time", "example": "2023-06-03T22:05:05.474+0000" }, "tenantId": { "type": "string", "example": "null" } } }, "Lane": { "type": "object", "properties": { "id": { "type": "string" }, "xmlRowNumber": { "type": "integer", "format": "int32" }, "xmlColumnNumber": { "type": "integer", "format": "int32" }, "extensionElements": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionElement" } } }, "attributes": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionAttribute" } } }, "name": { "type": "string" }, "parentProcess": { "$ref": "#/components/schemas/Process" }, "flowReferences": { "type": "array", "items": { "type": "string" } } } }, "MembershipRequest": { "type": "object", "properties": { "userId": { "type": "string", "example": "kermit" } } }, "MembershipResponse": { "type": "object", "properties": { "userId": { "type": "string", "example": "kermit" }, "url": { "type": "string", "example": "http://localhost:8182/identity/groups/sales/members/kermit" }, "groupId": { "type": "string", "example": "sales" } } }, "Message": { "type": "object", "properties": { "id": { "type": "string" }, "xmlRowNumber": { "type": "integer", "format": "int32" }, "xmlColumnNumber": { "type": "integer", "format": "int32" }, "extensionElements": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionElement" } } }, "attributes": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionAttribute" } } }, "name": { "type": "string" }, "itemRef": { "type": "string" } } }, "MessageFlow": { "type": "object", "properties": { "id": { "type": "string" }, "xmlRowNumber": { "type": "integer", "format": "int32" }, "xmlColumnNumber": { "type": "integer", "format": "int32" }, "extensionElements": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionElement" } } }, "attributes": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionAttribute" } } }, "name": { "type": "string" }, "sourceRef": { "type": "string" }, "targetRef": { "type": "string" }, "messageRef": { "type": "string" } } }, "ModelRequest": { "type": "object", "properties": { "name": { "type": "string", "example": "Model name" }, "key": { "type": "string", "example": "Model key" }, "category": { "type": "string", "example": "Model category" }, "version": { "type": "integer", "format": "int32", "example": 2 }, "metaInfo": { "type": "string", "example": "Model metainfo" }, "deploymentId": { "type": "string", "example": "7" }, "tenantId": { "type": "string", "example": "null" } } }, "ModelResponse": { "type": "object", "properties": { "name": { "type": "string", "example": "Model name" }, "key": { "type": "string", "example": "Model key" }, "category": { "type": "string", "example": "Model category" }, "version": { "type": "integer", "format": "int32", "example": 2 }, "metaInfo": { "type": "string", "example": "Model metainfo" }, "deploymentId": { "type": "string", "example": "7" }, "tenantId": { "type": "string", "example": "null" }, "id": { "type": "string", "example": "5" }, "url": { "type": "string", "example": "http://localhost:8182/repository/models/5" }, "createTime": { "type": "string", "format": "date-time", "example": "2013-06-12T12:31:19.861+0000" }, "lastUpdateTime": { "type": "string", "format": "date-time", "example": "2013-06-12T12:31:19.861+0000" }, "deploymentUrl": { "type": "string", "example": "http://localhost:8182/repository/deployments/2" }, "sourceUrl": { "type": "string" }, "sourceExtraUrl": { "type": "string" } } }, "Operation": { "type": "object", "properties": { "id": { "type": "string" }, "xmlRowNumber": { "type": "integer", "format": "int32" }, "xmlColumnNumber": { "type": "integer", "format": "int32" }, "extensionElements": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionElement" } } }, "attributes": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionAttribute" } } }, "name": { "type": "string" }, "implementationRef": { "type": "string" }, "inMessageRef": { "type": "string" }, "outMessageRef": { "type": "string" }, "errorMessageRef": { "type": "array", "items": { "type": "string" } } } }, "Pool": { "type": "object", "properties": { "id": { "type": "string" }, "xmlRowNumber": { "type": "integer", "format": "int32" }, "xmlColumnNumber": { "type": "integer", "format": "int32" }, "extensionElements": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionElement" } } }, "attributes": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionAttribute" } } }, "name": { "type": "string" }, "processRef": { "type": "string" }, "executable": { "type": "boolean" } } }, "Process": { "type": "object", "properties": { "id": { "type": "string" }, "xmlRowNumber": { "type": "integer", "format": "int32" }, "xmlColumnNumber": { "type": "integer", "format": "int32" }, "extensionElements": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionElement" } } }, "attributes": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionAttribute" } } }, "name": { "type": "string" }, "executable": { "type": "boolean" }, "documentation": { "type": "string" }, "ioSpecification": { "$ref": "#/components/schemas/IOSpecification" }, "executionListeners": { "type": "array", "items": { "$ref": "#/components/schemas/FlowableListener" } }, "lanes": { "type": "array", "items": { "$ref": "#/components/schemas/Lane" } }, "dataObjects": { "type": "array", "items": { "$ref": "#/components/schemas/ValuedDataObject" } }, "candidateStarterUsers": { "type": "array", "items": { "type": "string" } }, "candidateStarterGroups": { "type": "array", "items": { "type": "string" } }, "eventListeners": { "type": "array", "items": { "$ref": "#/components/schemas/EventListener" } }, "flowElementMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FlowElement" } }, "artifactMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Artifact" } }, "initialFlowElement": { "$ref": "#/components/schemas/FlowElement" }, "enableEagerExecutionTreeFetching": { "type": "boolean" }, "artifacts": { "type": "array", "items": { "$ref": "#/components/schemas/Artifact" } }, "flowElements": { "type": "array", "items": { "$ref": "#/components/schemas/FlowElement" } } } }, "ProcessDefinitionActionRequest": { "type": "object", "required": [ "action" ], "properties": { "action": { "type": "string", "example": "activate", "description": "Action to perform: Either activate or suspend" }, "includeProcessInstances": { "type": "boolean", "description": "Whether or not to suspend/activate running process-instances for this process-definition. If omitted, the process-instances are left in the state they are" }, "date": { "type": "string", "format": "date-time", "description": "Date (ISO-8601) when the suspension/activation should be executed. If omitted, the suspend/activation is effective immediately." }, "category": { "type": "string" } } }, "ProcessDefinitionResponse": { "type": "object", "properties": { "id": { "type": "string", "example": "oneTaskProcess:1:4" }, "url": { "type": "string", "example": "http://localhost:8182/repository/process-definitions/oneTaskProcess%3A1%3A4" }, "key": { "type": "string", "example": "oneTaskProcess" }, "version": { "type": "integer", "format": "int32", "example": 1 }, "name": { "type": "string", "example": "The One Task Process" }, "description": { "type": "string", "example": "This is a process for testing purposes" }, "tenantId": { "type": "string", "example": "null" }, "deploymentId": { "type": "string", "example": "2" }, "deploymentUrl": { "type": "string", "example": "http://localhost:8081/repository/deployments/2" }, "resource": { "type": "string", "example": "http://localhost:8182/repository/deployments/2/resources/testProcess.xml", "description": "Contains the actual deployed BPMN 2.0 xml." }, "diagramResource": { "type": "string", "example": "http://localhost:8182/repository/deployments/2/resources/testProcess.png", "description": "Contains a graphical representation of the process, null when no diagram is available." }, "category": { "type": "string", "example": "Examples" }, "graphicalNotationDefined": { "type": "boolean", "description": "Indicates the process definition contains graphical information (BPMN DI)." }, "suspended": { "type": "boolean" }, "startFormDefined": { "type": "boolean" } } }, "ProcessInstanceCreateRequest": { "type": "object", "properties": { "processDefinitionId": { "type": "string", "example": "oneTaskProcess:1:158" }, "processDefinitionKey": { "type": "string", "example": "oneTaskProcess" }, "message": { "type": "string", "example": "newOrderMessage" }, "name": { "type": "string", "example": "myProcessInstanceName" }, "businessKey": { "type": "string", "example": "myBusinessKey" }, "variables": { "type": "array", "items": { "$ref": "#/components/schemas/RestVariable" } }, "transientVariables": { "type": "array", "items": { "$ref": "#/components/schemas/RestVariable" } }, "startFormVariables": { "type": "array", "items": { "$ref": "#/components/schemas/RestVariable" } }, "outcome": { "type": "string" }, "tenantId": { "type": "string", "example": "tenant1" }, "overrideDefinitionTenantId": { "type": "string", "example": "overrideTenant1" }, "returnVariables": { "type": "boolean" } }, "description": "Only one of processDefinitionId, processDefinitionKey or message can be used in the request body" }, "ProcessInstanceQueryRequest": { "type": "object", "properties": { "start": { "type": "integer", "format": "int32" }, "size": { "type": "integer", "format": "int32" }, "sort": { "type": "string" }, "order": { "type": "string" }, "processInstanceId": { "type": "string" }, "processInstanceIds": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "processInstanceName": { "type": "string" }, "processInstanceNameLike": { "type": "string" }, "processInstanceNameLikeIgnoreCase": { "type": "string" }, "processBusinessKey": { "type": "string" }, "processBusinessKeyLike": { "type": "string" }, "processBusinessKeyLikeIgnoreCase": { "type": "string" }, "processBusinessStatus": { "type": "string" }, "processBusinessStatusLike": { "type": "string" }, "processBusinessStatusLikeIgnoreCase": { "type": "string" }, "processDefinitionId": { "type": "string" }, "processDefinitionIds": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "processDefinitionKey": { "type": "string" }, "processDefinitionKeyLike": { "type": "string" }, "processDefinitionKeyLikeIgnoreCase": { "type": "string" }, "processDefinitionKeys": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "excludeProcessDefinitionKeys": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "processDefinitionName": { "type": "string" }, "processDefinitionNameLike": { "type": "string" }, "processDefinitionNameLikeIgnoreCase": { "type": "string" }, "processDefinitionCategory": { "type": "string" }, "processDefinitionCategoryLike": { "type": "string" }, "processDefinitionCategoryLikeIgnoreCase": { "type": "string" }, "processDefinitionVersion": { "type": "integer", "format": "int32" }, "processDefinitionEngineVersion": { "type": "string" }, "rootScopeId": { "type": "string" }, "parentScopeId": { "type": "string" }, "deploymentId": { "type": "string" }, "deploymentIdIn": { "type": "array", "items": { "type": "string" } }, "superProcessInstanceId": { "type": "string" }, "subProcessInstanceId": { "type": "string" }, "excludeSubprocesses": { "type": "boolean" }, "activeActivityId": { "type": "string" }, "activeActivityIds": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "involvedUser": { "type": "string" }, "startedBy": { "type": "string" }, "startedBefore": { "type": "string", "format": "date-time" }, "startedAfter": { "type": "string", "format": "date-time" }, "suspended": { "type": "boolean" }, "includeProcessVariables": { "type": "boolean" }, "includeProcessVariablesNames": { "type": "array", "items": { "type": "string" } }, "variables": { "type": "array", "items": { "$ref": "#/components/schemas/QueryVariable" } }, "callbackId": { "type": "string" }, "callbackIds": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "callbackType": { "type": "string" }, "parentCaseInstanceId": { "type": "string" }, "tenantId": { "type": "string" }, "tenantIdLike": { "type": "string" }, "tenantIdLikeIgnoreCase": { "type": "string" }, "withoutTenantId": { "type": "boolean" } } }, "ProcessInstanceQueryResource": { "type": "object" }, "ProcessInstanceResponse": { "type": "object", "properties": { "id": { "type": "string", "example": "187" }, "url": { "type": "string", "example": "http://localhost:8182/repository/process-definitions/processOne%3A1%3A4" }, "name": { "type": "string", "example": "myProcessInstanceName" }, "businessKey": { "type": "string", "example": "myBusinessKey" }, "businessStatus": { "type": "string", "example": "myBusinessStatus" }, "suspended": { "type": "boolean" }, "ended": { "type": "boolean" }, "processDefinitionId": { "type": "string", "example": "oneTaskProcess:1:158" }, "processDefinitionUrl": { "type": "string", "example": "http://localhost:8182/repository/process-definitions/processOne%3A1%3A4" }, "processDefinitionName": { "type": "string", "example": "A process definition name" }, "processDefinitionDescription": { "type": "string", "example": "A process definition description" }, "activityId": { "type": "string", "example": "processTask" }, "startUserId": { "type": "string", "example": "johnDoe" }, "startTime": { "type": "string", "example": "2018-04-17T10:17:43.902+0000" }, "superProcessInstanceId": { "type": "string", "example": "3" }, "variables": { "type": "array", "items": { "$ref": "#/components/schemas/RestVariable" } }, "callbackId": { "type": "string", "example": "3" }, "callbackType": { "type": "string", "example": "cmmn" }, "referenceId": { "type": "string", "example": "123" }, "referenceType": { "type": "string", "example": "event-to-bpmn-2.0-process" }, "propagatedStageInstanceId": { "type": "string", "description": "The stage plan item instance id this process instance belongs to or null, if it is not part of a case at all or is not a child element of a stage" }, "tenantId": { "type": "string", "example": "someTenantId" }, "completed": { "type": "boolean" } } }, "ProcessInstanceUpdateRequest": { "type": "object", "required": [ "action" ], "properties": { "action": { "type": "string", "example": "activate", "description": "Action to perform: Either activate or suspend" }, "name": { "type": "string" }, "businessKey": { "type": "string" } } }, "ProcessInstanceVariableCollectionResource": { "type": "object" }, "ProcessInstanceVariableResource": { "type": "object" }, "PropertyRequestBody": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } }, "QueryVariable": { "type": "object", "properties": { "name": { "type": "string" }, "operation": { "type": "string", "enum": [ "equals", "notEquals", "equalsIgnoreCase", "notEqualsIgnoreCase", "like", "likeIgnoreCase", "greaterThan", "greaterThanOrEquals", "lessThan", "lessThanOrEquals" ] }, "value": { "type": "object" }, "type": { "type": "string" } } }, "Resource": { "type": "object", "properties": { "id": { "type": "string" }, "xmlRowNumber": { "type": "integer", "format": "int32" }, "xmlColumnNumber": { "type": "integer", "format": "int32" }, "extensionElements": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionElement" } } }, "attributes": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionAttribute" } } }, "name": { "type": "string" } } }, "RestActionRequest": { "type": "object", "properties": { "action": { "type": "string" } } }, "RestEnumFormProperty": { "type": "object", "properties": { "id": { "type": "string", "example": "normal" }, "name": { "type": "string", "example": "Normal bed" } } }, "RestFormProperty": { "type": "object", "properties": { "id": { "type": "string", "example": "room" }, "name": { "type": "string", "example": "Room" }, "type": { "type": "string", "example": "string" }, "value": { "type": "string" }, "readable": { "type": "boolean" }, "writable": { "type": "boolean" }, "required": { "type": "boolean" }, "datePattern": { "type": "string" }, "enumValues": { "type": "array", "items": { "$ref": "#/components/schemas/RestEnumFormProperty" } } } }, "RestIdentityLink": { "type": "object", "properties": { "url": { "type": "string" }, "user": { "type": "string", "example": "kermit" }, "group": { "type": "string", "example": "sales" }, "type": { "type": "string", "example": "candidate" } } }, "RestVariable": { "type": "object", "properties": { "name": { "type": "string", "example": "myVariable", "description": "Name of the variable" }, "type": { "type": "string", "example": "string", "description": "Type of the variable." }, "value": { "type": "object", "example": "test", "description": "Value of the variable." }, "valueUrl": { "type": "string", "example": "http://...." }, "scope": { "type": "string" } } }, "ScriptInfo": { "type": "object", "properties": { "id": { "type": "string" }, "xmlRowNumber": { "type": "integer", "format": "int32" }, "xmlColumnNumber": { "type": "integer", "format": "int32" }, "extensionElements": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionElement" } } }, "attributes": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionAttribute" } } }, "language": { "type": "string" }, "resultVariable": { "type": "string" }, "script": { "type": "string" } } }, "Signal": { "type": "object", "properties": { "id": { "type": "string" }, "xmlRowNumber": { "type": "integer", "format": "int32" }, "xmlColumnNumber": { "type": "integer", "format": "int32" }, "extensionElements": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionElement" } } }, "attributes": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionAttribute" } } }, "name": { "type": "string" }, "scope": { "type": "string" } } }, "SignalEventReceivedRequest": { "type": "object", "properties": { "signalName": { "type": "string", "description": "Name of the signal" }, "variables": { "type": "array", "description": "Array of variables (in the general variables format) to use as payload to pass along with the signal. Cannot be used in case async is set to true, this will result in an error.", "items": { "$ref": "#/components/schemas/RestVariable" } }, "tenantId": { "type": "string", "description": "ID of the tenant that the signal event should be processed in" }, "async": { "type": "boolean", "description": "If true, handling of the signal will happen asynchronously. Return code will be 202 - Accepted to indicate the request is accepted but not yet executed. If false,\n handling the signal will be done immediately and result (200 - OK) will only return after this completed successfully. Defaults to false if omitted." } } }, "SubmitFormRequest": { "type": "object", "properties": { "action": { "type": "string" }, "processDefinitionId": { "type": "string" }, "taskId": { "type": "string" }, "businessKey": { "type": "string" }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/RestFormProperty" } } } }, "TableMetaData": { "type": "object", "properties": { "tableName": { "type": "string" }, "columnNames": { "type": "array", "items": { "type": "string" } }, "columnTypes": { "type": "array", "items": { "type": "string" } } } }, "TableResponse": { "type": "object", "properties": { "name": { "type": "string", "example": "ACT_RU_VARIABLE" }, "url": { "type": "string", "example": "http://localhost:8080/flowable-rest/service/management/tables/ACT_RU_VARIABLE" }, "count": { "type": "integer", "format": "int64", "example": 4528 } } }, "TaskActionRequest": { "type": "object", "required": [ "action" ], "properties": { "action": { "type": "string", "example": "complete", "description": "Action to perform: Either complete, claim, delegate or resolve" }, "assignee": { "type": "string", "example": "userWhoClaims/userToDelegateTo", "description": "If action is claim or delegate, you can use this parameter to set the assignee associated " }, "formDefinitionId": { "type": "string", "example": "12345", "description": "Required when completing a task with a form" }, "outcome": { "type": "string", "example": "accepted/rejected", "description": "Optional outcome value when completing a task with a form" }, "variables": { "type": "array", "description": "If action is complete, you can use this parameter to set variables ", "items": { "$ref": "#/components/schemas/RestVariable" } }, "transientVariables": { "type": "array", "description": "If action is complete, you can use this parameter to set transient variables ", "items": { "$ref": "#/components/schemas/RestVariable" } } } }, "TaskAttachmentCollectionResource": { "type": "object" }, "TaskQueryRequest": { "type": "object", "properties": { "start": { "type": "integer", "format": "int32" }, "size": { "type": "integer", "format": "int32" }, "sort": { "type": "string" }, "order": { "type": "string" }, "taskId": { "type": "string" }, "name": { "type": "string" }, "nameLike": { "type": "string" }, "nameLikeIgnoreCase": { "type": "string" }, "description": { "type": "string" }, "descriptionLike": { "type": "string" }, "priority": { "type": "integer", "format": "int32" }, "minimumPriority": { "type": "integer", "format": "int32" }, "maximumPriority": { "type": "integer", "format": "int32" }, "assignee": { "type": "string" }, "assigneeLike": { "type": "string" }, "owner": { "type": "string" }, "ownerLike": { "type": "string" }, "unassigned": { "type": "boolean" }, "delegationState": { "type": "string" }, "candidateUser": { "type": "string" }, "candidateGroup": { "type": "string" }, "candidateGroupIn": { "type": "array", "items": { "type": "string" } }, "ignoreAssignee": { "type": "boolean" }, "involvedUser": { "type": "string" }, "processInstanceId": { "type": "string" }, "processInstanceIdWithChildren": { "type": "string" }, "withoutProcessInstanceId": { "type": "boolean" }, "processInstanceBusinessKey": { "type": "string" }, "processInstanceBusinessKeyLike": { "type": "string" }, "processDefinitionId": { "type": "string" }, "processDefinitionKey": { "type": "string" }, "processDefinitionName": { "type": "string" }, "processDefinitionKeyLike": { "type": "string" }, "processDefinitionNameLike": { "type": "string" }, "executionId": { "type": "string" }, "createdOn": { "type": "string", "format": "date-time" }, "createdBefore": { "type": "string", "format": "date-time" }, "createdAfter": { "type": "string", "format": "date-time" }, "excludeSubTasks": { "type": "boolean" }, "taskDefinitionKey": { "type": "string" }, "taskDefinitionKeyLike": { "type": "string" }, "taskDefinitionKeys": { "type": "array", "items": { "type": "string" } }, "dueDate": { "type": "string", "format": "date-time" }, "dueBefore": { "type": "string", "format": "date-time" }, "dueAfter": { "type": "string", "format": "date-time" }, "withoutDueDate": { "type": "boolean" }, "active": { "type": "boolean" }, "includeTaskLocalVariables": { "type": "boolean" }, "includeProcessVariables": { "type": "boolean" }, "scopeDefinitionId": { "type": "string" }, "scopeId": { "type": "string" }, "scopeIds": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "withoutScopeId": { "type": "boolean" }, "scopeType": { "type": "string" }, "propagatedStageInstanceId": { "type": "string" }, "tenantId": { "type": "string" }, "tenantIdLike": { "type": "string" }, "withoutTenantId": { "type": "boolean" }, "candidateOrAssigned": { "type": "string" }, "category": { "type": "string" }, "categoryIn": { "type": "array", "items": { "type": "string" } }, "categoryNotIn": { "type": "array", "items": { "type": "string" } }, "withoutCategory": { "type": "boolean" }, "rootScopeId": { "type": "string" }, "parentScopeId": { "type": "string" }, "taskVariables": { "type": "array", "items": { "$ref": "#/components/schemas/QueryVariable" } }, "processInstanceVariables": { "type": "array", "items": { "$ref": "#/components/schemas/QueryVariable" } } } }, "TaskQueryResource": { "type": "object" }, "TaskRequest": { "type": "object", "properties": { "owner": { "type": "string" }, "assignee": { "type": "string" }, "delegationState": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "dueDate": { "type": "string", "format": "date-time" }, "priority": { "type": "integer", "format": "int32" }, "parentTaskId": { "type": "string" }, "category": { "type": "string" }, "tenantId": { "type": "string" }, "formKey": { "type": "string" }, "ownerSet": { "type": "boolean" }, "assigneeSet": { "type": "boolean" }, "delegationStateSet": { "type": "boolean" }, "nameSet": { "type": "boolean" }, "descriptionSet": { "type": "boolean" }, "duedateSet": { "type": "boolean" }, "prioritySet": { "type": "boolean" }, "parentTaskIdSet": { "type": "boolean" }, "categorySet": { "type": "boolean" }, "tenantIdSet": { "type": "boolean" }, "formKeySet": { "type": "boolean" } } }, "TaskResponse": { "type": "object", "properties": { "id": { "type": "string", "example": "8" }, "url": { "type": "string", "example": "http://localhost:8182/runtime/tasks/8" }, "owner": { "type": "string", "example": "owner" }, "assignee": { "type": "string", "example": "kermit" }, "delegationState": { "type": "string", "example": "pending", "description": "Delegation-state of the task, can be null, \"pending\" or \"resolved\"." }, "name": { "type": "string", "example": "My task" }, "description": { "type": "string", "example": "Task description" }, "createTime": { "type": "string", "format": "date-time", "example": "2018-04-17T10:17:43.902+0000" }, "dueDate": { "type": "string", "format": "date-time", "example": "2018-04-17T10:17:43.902+0000" }, "priority": { "type": "integer", "format": "int32", "example": 50 }, "suspended": { "type": "boolean" }, "claimTime": { "type": "string", "example": "2018-04-17T10:17:43.902+0000" }, "taskDefinitionKey": { "type": "string", "example": "theTask" }, "scopeDefinitionId": { "type": "string", "example": "12" }, "scopeId": { "type": "string", "example": "14" }, "subScopeId": { "type": "string", "example": "15" }, "scopeType": { "type": "string", "example": "cmmn" }, "propagatedStageInstanceId": { "type": "string", "example": "16" }, "tenantId": { "type": "string", "example": "someTenantId" }, "category": { "type": "string", "example": "ExampleCategory" }, "formKey": { "type": "string" }, "parentTaskId": { "type": "string", "example": "null" }, "parentTaskUrl": { "type": "string", "example": "null" }, "executionId": { "type": "string", "example": "5" }, "executionUrl": { "type": "string", "example": "http://localhost:8182/runtime/executions/5" }, "processInstanceId": { "type": "string", "example": "5" }, "processInstanceUrl": { "type": "string", "example": "http://localhost:8182/runtime/process-instances/5" }, "processDefinitionId": { "type": "string", "example": "oneTaskProcess%3A1%3A4" }, "processDefinitionUrl": { "type": "string", "example": "http://localhost:8182/runtime/process-definitions/oneTaskProcess%3A1%3A4" }, "variables": { "type": "array", "items": { "$ref": "#/components/schemas/RestVariable" } } } }, "TaskVariableCollectionResource": { "type": "object" }, "TaskVariableResource": { "type": "object" }, "TimerJobActionRequest": { "type": "object", "properties": { "action": { "type": "string" }, "dueDate": { "type": "string" } } }, "UserInfoRequest": { "type": "object", "properties": { "key": { "type": "string", "example": "jobTitle" }, "value": { "type": "string", "example": "Muppet" } } }, "UserInfoResponse": { "type": "object", "properties": { "key": { "type": "string", "example": "jobTitle" }, "value": { "type": "string", "example": "Muppet" }, "url": { "type": "string", "example": "http://localhost:8080/flowable-rest/service/identity/users/kermit/info/jobTitle" } } }, "UserRequest": { "type": "object", "properties": { "id": { "type": "string", "example": "testuser" }, "firstName": { "type": "string", "example": "Fred" }, "lastName": { "type": "string", "example": "Smith" }, "displayName": { "type": "string", "example": "Fred Smith" }, "url": { "type": "string", "example": "http://localhost:8182/identity/users/testuser" }, "email": { "type": "string", "example": "no-reply@flowable.org" }, "tenantId": { "type": "string", "example": "companyTenantId" }, "pictureUrl": { "type": "string", "example": "http://localhost:8182/identity/users/testuser/picture" }, "password": { "type": "string" } } }, "UserResponse": { "type": "object", "properties": { "id": { "type": "string", "example": "testuser" }, "firstName": { "type": "string", "example": "Fred" }, "lastName": { "type": "string", "example": "Smith" }, "displayName": { "type": "string", "example": "Fred Smith" }, "url": { "type": "string", "example": "http://localhost:8182/identity/users/testuser" }, "email": { "type": "string", "example": "no-reply@flowable.org" }, "tenantId": { "type": "string", "example": "companyTenantId" }, "pictureUrl": { "type": "string", "example": "http://localhost:8182/identity/users/testuser/picture" }, "password": { "type": "string" } } }, "ValuedDataObject": { "type": "object", "properties": { "id": { "type": "string" }, "xmlRowNumber": { "type": "integer", "format": "int32" }, "xmlColumnNumber": { "type": "integer", "format": "int32" }, "extensionElements": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionElement" } } }, "attributes": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionAttribute" } } }, "name": { "type": "string" }, "documentation": { "type": "string" }, "executionListeners": { "type": "array", "items": { "$ref": "#/components/schemas/FlowableListener" } }, "itemSubjectRef": { "$ref": "#/components/schemas/ItemDefinition" }, "value": { "type": "object" }, "type": { "type": "string" } } }, "VariableInstanceQueryRequest": { "type": "object", "properties": { "start": { "type": "integer", "format": "int32" }, "size": { "type": "integer", "format": "int32" }, "sort": { "type": "string" }, "order": { "type": "string" }, "excludeTaskVariables": { "type": "boolean" }, "taskId": { "type": "string" }, "executionId": { "type": "string" }, "processInstanceId": { "type": "string" }, "variableName": { "type": "string" }, "variableNameLike": { "type": "string" }, "excludeLocalVariables": { "type": "boolean" }, "variables": { "type": "array", "items": { "$ref": "#/components/schemas/QueryVariable" } } } }, "VariableInstanceQueryResource": { "type": "object" }, "VariableInstanceResponse": { "type": "object", "properties": { "id": { "type": "string", "example": "14" }, "processInstanceId": { "type": "string", "example": "5" }, "processInstanceUrl": { "type": "string", "example": "http://localhost:8182/history/historic-process-instances/5" }, "taskId": { "type": "string", "example": "6" }, "executionId": { "type": "string" }, "variable": { "$ref": "#/components/schemas/RestVariable" } } } } }