{ "$schema": "http://json-schema.org/draft-07/schema#", "title": "Flowable CMMN API Schemas", "description": "JSON Schema definitions extracted from the Flowable CMMN OpenAPI specification", "definitions": { "Association": { "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" } } }, "documentationTextFormat": { "type": "string" }, "documentation": { "type": "string" }, "sourceRef": { "type": "string" }, "sourceElement": { "$ref": "#/components/schemas/BaseElement" }, "targetRef": { "type": "string" }, "targetElement": { "$ref": "#/components/schemas/BaseElement" }, "transitionEvent": { "type": "string" } } }, "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" } } } } }, "BulkDeleteInstancesRestActionRequest": { "type": "object", "properties": { "action": { "type": "string" }, "instanceIds": { "type": "array", "items": { "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" } } } }, "Case": { "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" } } }, "documentationTextFormat": { "type": "string" }, "documentation": { "type": "string" }, "name": { "type": "string" }, "initiatorVariableName": { "type": "string" }, "planModel": { "$ref": "#/components/schemas/Stage" }, "startEventType": { "type": "string" }, "candidateStarterUsers": { "type": "array", "items": { "type": "string" } }, "candidateStarterGroups": { "type": "array", "items": { "type": "string" } }, "async": { "type": "boolean" }, "allCaseElements": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CaseElement" } }, "lifecycleListeners": { "type": "array", "items": { "$ref": "#/components/schemas/FlowableListener" } }, "reactivateEventListener": { "$ref": "#/components/schemas/ReactivateEventListener" } } }, "CaseDefinitionActionRequest": { "type": "object", "properties": { "action": { "type": "string" }, "category": { "type": "string" } } }, "CaseDefinitionResponse": { "type": "object", "properties": { "id": { "type": "string", "example": "oneTaskCase:1:4" }, "url": { "type": "string", "example": "http://localhost:8182/cmmn-repository/case-definitions/oneTaskCase%3A1%3A4" }, "key": { "type": "string", "example": "oneTaskCase" }, "version": { "type": "integer", "format": "int32", "example": 1 }, "name": { "type": "string", "example": "The One Task Case" }, "description": { "type": "string", "example": "This is a case for testing purposes" }, "tenantId": { "type": "string", "example": "null" }, "deploymentId": { "type": "string", "example": "2" }, "deploymentUrl": { "type": "string", "example": "http://localhost:8081/cmmn-repository/deployments/2" }, "resource": { "type": "string", "example": "http://localhost:8182/cmmn-repository/deployments/2/resources/testCase.cmmn", "description": "Contains the actual deployed CMMN 1.1 xml." }, "diagramResource": { "type": "string", "example": "http://localhost:8182/cmmn-repository/deployments/2/resources/testProcess.png", "description": "Contains a graphical representation of the case, null when no diagram is available." }, "category": { "type": "string", "example": "Examples" }, "graphicalNotationDefined": { "type": "boolean", "description": "Indicates the case definition contains graphical information (CMMN DI)." }, "startFormDefined": { "type": "boolean" } } }, "CaseElement": { "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" } } }, "documentationTextFormat": { "type": "string" }, "documentation": { "type": "string" }, "name": { "type": "string" }, "parent": { "$ref": "#/components/schemas/PlanFragment" }, "parentStage": { "$ref": "#/components/schemas/Stage" } } }, "CaseInstanceCreateRequest": { "type": "object", "properties": { "caseDefinitionId": { "type": "string", "example": "oneTaskCase:1:158" }, "caseDefinitionKey": { "type": "string", "example": "oneTaskCase" }, "name": { "type": "string", "example": "My case name" }, "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 caseDefinitionId or caseDefinitionKey can be used in the request body" }, "CaseInstanceQueryRequest": { "type": "object", "properties": { "start": { "type": "integer", "format": "int32" }, "size": { "type": "integer", "format": "int32" }, "sort": { "type": "string" }, "order": { "type": "string" }, "caseInstanceId": { "type": "string" }, "caseInstanceIds": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "caseDefinitionId": { "type": "string" }, "caseDefinitionKey": { "type": "string" }, "caseDefinitionKeyLike": { "type": "string" }, "caseDefinitionKeyLikeIgnoreCase": { "type": "string" }, "caseDefinitionKeys": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "excludeCaseDefinitionKeys": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "caseDefinitionCategory": { "type": "string" }, "caseDefinitionCategoryLike": { "type": "string" }, "caseDefinitionCategoryLikeIgnoreCase": { "type": "string" }, "caseDefinitionName": { "type": "string" }, "caseDefinitionNameLike": { "type": "string" }, "caseDefinitionNameLikeIgnoreCase": { "type": "string" }, "caseBusinessKey": { "type": "string" }, "caseInstanceName": { "type": "string" }, "caseInstanceNameLike": { "type": "string" }, "caseInstanceNameLikeIgnoreCase": { "type": "string" }, "caseInstanceRootScopeId": { "type": "string" }, "caseInstanceParentScopeId": { "type": "string" }, "caseInstanceBusinessKey": { "type": "string" }, "caseInstanceBusinessKeyLike": { "type": "string" }, "caseInstanceBusinessKeyLikeIgnoreCase": { "type": "string" }, "caseInstanceBusinessStatus": { "type": "string" }, "caseInstanceBusinessStatusLike": { "type": "string" }, "caseInstanceBusinessStatusLikeIgnoreCase": { "type": "string" }, "caseInstanceParentId": { "type": "string" }, "caseInstanceStartedBy": { "type": "string" }, "caseInstanceStartedBefore": { "type": "string", "format": "date-time" }, "caseInstanceStartedAfter": { "type": "string", "format": "date-time" }, "caseInstanceState": { "type": "string" }, "involvedUser": { "type": "string" }, "caseInstanceCallbackId": { "type": "string" }, "caseInstanceCallbackIds": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "caseInstanceCallbackType": { "type": "string" }, "parentCaseInstanceId": { "type": "string" }, "caseInstanceReferenceId": { "type": "string" }, "caseInstanceReferenceType": { "type": "string" }, "caseInstanceLastReactivatedBy": { "type": "string" }, "caseInstanceLastReactivatedBefore": { "type": "string", "format": "date-time" }, "caseInstanceLastReactivatedAfter": { "type": "string", "format": "date-time" }, "includeCaseVariables": { "type": "boolean" }, "includeCaseVariablesNames": { "type": "array", "items": { "type": "string" } }, "variables": { "type": "array", "items": { "$ref": "#/components/schemas/QueryVariable" } }, "activePlanItemDefinitionId": { "type": "string" }, "activePlanItemDefinitionIds": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "tenantId": { "type": "string" }, "tenantIdLike": { "type": "string" }, "tenantIdLikeIgnoreCase": { "type": "string" }, "withoutTenantId": { "type": "boolean" } } }, "CaseInstanceQueryResource": { "type": "object" }, "CaseInstanceResponse": { "type": "object", "properties": { "id": { "type": "string", "example": "187" }, "name": { "type": "string", "example": "processName" }, "url": { "type": "string", "example": "http://localhost:8182/cmmn-repository/case-definitions/caseOne%3A1%3A4" }, "businessKey": { "type": "string", "example": "myBusinessKey" }, "businessStatus": { "type": "string", "example": "myBusinessStatus" }, "startTime": { "type": "string", "format": "date-time", "example": "2019-04-17T10:17:43.902+0000" }, "startUserId": { "type": "string", "example": "aUserId" }, "state": { "type": "string", "example": "active" }, "ended": { "type": "boolean" }, "caseDefinitionId": { "type": "string", "example": "oneTaskCase:1:158" }, "caseDefinitionUrl": { "type": "string", "example": "http://localhost:8182/cmmn-repository/case-definitions/caseOne%3A1%3A4" }, "caseDefinitionName": { "type": "string", "example": "aCaseDefinitionName" }, "caseDefinitionDescription": { "type": "string", "example": "A case definition description" }, "parentId": { "type": "string", "example": "123" }, "callbackId": { "type": "string", "example": "123" }, "callbackType": { "type": "string", "example": "cmmn-1.1-to-cmmn-1.1-child-case" }, "referenceId": { "type": "string", "example": "123" }, "referenceType": { "type": "string", "example": "event-to-cmmn-1.1-case" }, "variables": { "type": "array", "items": { "$ref": "#/components/schemas/RestVariable" } }, "tenantId": { "type": "string", "example": "null" }, "completed": { "type": "boolean" } } }, "CaseInstanceUpdateRequest": { "type": "object", "properties": { "action": { "type": "string" }, "name": { "type": "string" }, "businessKey": { "type": "string" } } }, "CaseInstanceVariableCollectionResource": { "type": "object" }, "CaseInstanceVariableResource": { "type": "object" }, "ChangePlanItemStateRequest": { "type": "object", "properties": { "activatePlanItemDefinitionIds": { "type": "array", "description": "plan item definition ids to be activated", "items": { "type": "string" } }, "moveToAvailablePlanItemDefinitionIds": { "type": "array", "description": "plan item definition ids to be moved to available state", "items": { "type": "string" } }, "terminatePlanItemDefinitionIds": { "type": "array", "description": "plan item definition ids to be terminated", "items": { "type": "string" } }, "addWaitingForRepetitionPlanItemDefinitionIds": { "type": "array", "description": "add waiting for repetition to provided plan item definition ids", "items": { "type": "string" } }, "removeWaitingForRepetitionPlanItemDefinitionIds": { "type": "array", "description": "remove waiting for repetition to provided plan item definition ids", "items": { "type": "string" } }, "changePlanItemIds": { "type": "object", "description": "map an existing plan item id to new plan item id, this should not be necessary in general, but could be needed when plan item ids change between case definition versions.", "additionalProperties": { "type": "string" } }, "changePlanItemIdsWithDefinitionId": { "type": "object", "description": "map an existing plan item id to new plan item id with the plan item definition id, this should not be necessary in general, but could be needed when plan item ids change between case definition versions.", "additionalProperties": { "type": "string" } }, "changePlanItemDefinitionsWithNewTargetIds": { "type": "array", "description": "map an existing plan item id to a new plan item id and plan item definition id, this should not be necessary in general, but could be needed when plan item ids change between case definition versions.", "items": { "$ref": "#/components/schemas/PlanItemDefinitionWithTargetIdsRequest" } } } }, "CmmnDeploymentResponse": { "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/cmmn-repository/deployments/10" }, "tenantId": { "type": "string" } } }, "CmmnDiEdge": { "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" } } }, "cmmnElementRef": { "type": "string" }, "targetCmmnElementRef": { "type": "string" }, "sourceDockerInfo": { "$ref": "#/components/schemas/GraphicInfo" }, "targetDockerInfo": { "$ref": "#/components/schemas/GraphicInfo" }, "waypoints": { "type": "array", "items": { "$ref": "#/components/schemas/GraphicInfo" } }, "labelGraphicInfo": { "$ref": "#/components/schemas/GraphicInfo" } } }, "CmmnModel": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "targetNamespace": { "type": "string" }, "expressionLanguage": { "type": "string" }, "exporter": { "type": "string" }, "exporterVersion": { "type": "string" }, "author": { "type": "string" }, "creationDate": { "type": "string", "format": "date-time" }, "definitionsAttributes": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionAttribute" } } }, "cases": { "type": "array", "items": { "$ref": "#/components/schemas/Case" } }, "processes": { "type": "array", "items": { "$ref": "#/components/schemas/Process" } }, "decisions": { "type": "array", "items": { "$ref": "#/components/schemas/Decision" } }, "associations": { "type": "array", "items": { "$ref": "#/components/schemas/Association" } }, "textAnnotations": { "type": "array", "items": { "$ref": "#/components/schemas/TextAnnotation" } }, "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/CmmnDiEdge" } }, "namespaces": { "type": "object", "additionalProperties": { "type": "string" } }, "primaryCase": { "$ref": "#/components/schemas/Case" } } }, "CompletionNeutralRule": { "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" } } }, "documentationTextFormat": { "type": "string" }, "documentation": { "type": "string" }, "name": { "type": "string" }, "parent": { "$ref": "#/components/schemas/PlanFragment" }, "condition": { "type": "string" }, "parentStage": { "$ref": "#/components/schemas/Stage" } } }, "Criterion": { "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" } } }, "documentationTextFormat": { "type": "string" }, "documentation": { "type": "string" }, "name": { "type": "string" }, "parent": { "$ref": "#/components/schemas/PlanFragment" }, "technicalId": { "type": "string" }, "sentryRef": { "type": "string" }, "sentry": { "$ref": "#/components/schemas/Sentry" }, "attachedToRefId": { "type": "string" }, "exitType": { "type": "string" }, "exitEventType": { "type": "string" }, "incomingAssociations": { "type": "array", "items": { "$ref": "#/components/schemas/Association" } }, "outgoingAssociations": { "type": "array", "items": { "$ref": "#/components/schemas/Association" } }, "entryCriterion": { "type": "boolean" }, "exitCriterion": { "type": "boolean" }, "parentStage": { "$ref": "#/components/schemas/Stage" } } }, "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" } } }, "DataResponseCaseDefinitionResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CaseDefinitionResponse" } }, "total": { "type": "integer", "format": "int64" }, "start": { "type": "integer", "format": "int32" }, "sort": { "type": "string" }, "order": { "type": "string" }, "size": { "type": "integer", "format": "int32" } } }, "DataResponseCaseInstanceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CaseInstanceResponse" } }, "total": { "type": "integer", "format": "int64" }, "start": { "type": "integer", "format": "int32" }, "sort": { "type": "string" }, "order": { "type": "string" }, "size": { "type": "integer", "format": "int32" } } }, "DataResponseCmmnDeploymentResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CmmnDeploymentResponse" } }, "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" } } }, "DataResponseHistoricCaseInstanceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/HistoricCaseInstanceResponse" } }, "total": { "type": "integer", "format": "int64" }, "start": { "type": "integer", "format": "int32" }, "sort": { "type": "string" }, "order": { "type": "string" }, "size": { "type": "integer", "format": "int32" } } }, "DataResponseHistoricMilestoneInstanceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/HistoricMilestoneInstanceResponse" } }, "total": { "type": "integer", "format": "int64" }, "start": { "type": "integer", "format": "int32" }, "sort": { "type": "string" }, "order": { "type": "string" }, "size": { "type": "integer", "format": "int32" } } }, "DataResponseHistoricPlanItemInstanceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/HistoricPlanItemInstanceResponse" } }, "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" } } }, "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" } } }, "DataResponsePlanItemInstanceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PlanItemInstanceResponse" } }, "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" } } }, "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" } } }, "Decision": { "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" } } }, "documentationTextFormat": { "type": "string" }, "documentation": { "type": "string" }, "name": { "type": "string" }, "externalRef": { "type": "string" }, "implementationType": { "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/cmmn-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/cmmn-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" ] } } }, "DmnDecision": { "type": "object", "properties": { "name": { "type": "string" }, "key": { "type": "string" }, "id": { "type": "string" }, "version": { "type": "integer", "format": "int32" }, "category": { "type": "string" }, "tenantId": { "type": "string" }, "description": { "type": "string" }, "resourceName": { "type": "string" }, "deploymentId": { "type": "string" }, "diagramResourceName": { "type": "string" }, "decisionType": { "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" } } }, "EventSubscriptionResponse": { "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "eventType": { "type": "string" }, "eventName": { "type": "string" }, "activityId": { "type": "string" }, "caseInstanceId": { "type": "string" }, "caseInstanceUrl": { "type": "string" }, "caseDefinitionId": { "type": "string" }, "caseDefinitionUrl": { "type": "string" }, "planItemInstanceId": { "type": "string" }, "planItemInstanceUrl": { "type": "string" }, "executionId": { "type": "string" }, "processInstanceId": { "type": "string" }, "processDefinitionId": { "type": "string" }, "scopeDefinitionId": { "type": "string" }, "scopeId": { "type": "string" }, "subScopeId": { "type": "string" }, "scopeType": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "configuration": { "type": "string" }, "tenantId": { "type": "string" } } }, "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" } } }, "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" } } }, "documentationTextFormat": { "type": "string" }, "documentation": { "type": "string" }, "event": { "type": "string" }, "sourceState": { "type": "string" }, "targetState": { "type": "string" }, "implementationType": { "type": "string" }, "implementation": { "type": "string" }, "fieldExtensions": { "type": "array", "items": { "$ref": "#/components/schemas/FieldExtension" } }, "onTransaction": { "type": "string" }, "scriptInfo": { "$ref": "#/components/schemas/ScriptInfo" } } }, "FormDefinition": { "type": "object", "properties": { "name": { "type": "string" }, "key": { "type": "string" }, "id": { "type": "string" }, "version": { "type": "integer", "format": "int32" }, "category": { "type": "string" }, "tenantId": { "type": "string" }, "description": { "type": "string" }, "resourceName": { "type": "string" }, "deploymentId": { "type": "string" } } }, "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": { "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" } } }, "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" }, "rotation": { "type": "number", "format": "double" } } }, "HistoricCaseInstanceQueryRequest": { "type": "object", "properties": { "start": { "type": "integer", "format": "int32" }, "size": { "type": "integer", "format": "int32" }, "sort": { "type": "string" }, "order": { "type": "string" }, "caseInstanceId": { "type": "string" }, "caseInstanceIds": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "caseDefinitionId": { "type": "string" }, "caseDefinitionKey": { "type": "string" }, "caseDefinitionKeyLike": { "type": "string" }, "caseDefinitionKeyLikeIgnoreCase": { "type": "string" }, "caseDefinitionKeys": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "excludeCaseDefinitionKeys": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "caseDefinitionCategory": { "type": "string" }, "caseDefinitionCategoryLike": { "type": "string" }, "caseDefinitionCategoryLikeIgnoreCase": { "type": "string" }, "caseDefinitionName": { "type": "string" }, "caseDefinitionNameLike": { "type": "string" }, "caseDefinitionNameLikeIgnoreCase": { "type": "string" }, "caseBusinessKey": { "type": "string" }, "caseInstanceName": { "type": "string" }, "caseInstanceNameLike": { "type": "string" }, "caseInstanceNameLikeIgnoreCase": { "type": "string" }, "caseInstanceRootScopeId": { "type": "string" }, "caseInstanceParentScopeId": { "type": "string" }, "caseInstanceBusinessKey": { "type": "string" }, "caseInstanceBusinessKeyLike": { "type": "string" }, "caseInstanceBusinessKeyLikeIgnoreCase": { "type": "string" }, "caseInstanceBusinessStatus": { "type": "string" }, "caseInstanceBusinessStatusLike": { "type": "string" }, "caseInstanceBusinessStatusLikeIgnoreCase": { "type": "string" }, "caseInstanceParentId": { "type": "string" }, "caseInstanceState": { "type": "string" }, "caseInstanceCallbackId": { "type": "string" }, "caseInstanceCallbackIds": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "caseInstanceCallbackType": { "type": "string" }, "parentCaseInstanceId": { "type": "string" }, "caseInstanceReferenceId": { "type": "string" }, "caseInstanceReferenceType": { "type": "string" }, "finished": { "type": "boolean" }, "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" }, "lastReactivatedBy": { "type": "string" }, "lastReactivatedBefore": { "type": "string", "format": "date-time" }, "lastReactivatedAfter": { "type": "string", "format": "date-time" }, "activePlanItemDefinitionId": { "type": "string" }, "activePlanItemDefinitionIds": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "includeCaseVariables": { "type": "boolean" }, "includeCaseVariablesNames": { "type": "array", "items": { "type": "string" } }, "variables": { "type": "array", "items": { "$ref": "#/components/schemas/QueryVariable" } }, "tenantId": { "type": "string" }, "tenantIdLike": { "type": "string" }, "tenantIdLikeIgnoreCase": { "type": "string" }, "withoutTenantId": { "type": "boolean" }, "withoutCaseInstanceParentId": { "type": "boolean" }, "withoutCaseInstanceCallbackId": { "type": "boolean" } } }, "HistoricCaseInstanceQueryResource": { "type": "object" }, "HistoricCaseInstanceResponse": { "type": "object", "properties": { "id": { "type": "string", "example": "5" }, "url": { "type": "string", "example": "http://localhost:8182/cmmn-history/historic-case-instances/5" }, "name": { "type": "string", "example": "myName" }, "businessKey": { "type": "string", "example": "myKey" }, "businessStatus": { "type": "string", "example": "myStatus" }, "caseDefinitionId": { "type": "string", "example": "oneTaskCase%3A1%3A4" }, "caseDefinitionUrl": { "type": "string", "example": "http://localhost:8182/cmmn-repository/case-definitions/oneTaskCaseProcess%3A1%3A4" }, "caseDefinitionName": { "type": "string", "example": "aCaseDefinitionName" }, "caseDefinitionDescription": { "type": "string", "example": "A case 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" }, "startUserId": { "type": "string", "example": "kermit" }, "endUserId": { "type": "string", "example": "kermit" }, "superProcessInstanceId": { "type": "string", "example": "3" }, "variables": { "type": "array", "items": { "$ref": "#/components/schemas/RestVariable" } }, "tenantId": { "type": "string", "example": "null" }, "state": { "type": "string", "example": "active" }, "callbackId": { "type": "string", "example": "123" }, "callbackType": { "type": "string", "example": "cmmn-1.1-to-cmmn-1.1-child-case" }, "referenceId": { "type": "string", "example": "123" }, "referenceType": { "type": "string", "example": "event-to-cmmn-1.1-case" } } }, "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" }, "caseInstanceId": { "type": "string", "example": "5" }, "caseInstanceUrl": { "type": "string", "example": "http://localhost:8182/cmmn-history/historic-case-instances/5" } } }, "HistoricMilestoneInstanceQueryRequest": { "type": "object", "properties": { "start": { "type": "integer", "format": "int32" }, "size": { "type": "integer", "format": "int32" }, "sort": { "type": "string" }, "order": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "caseInstanceId": { "type": "string" }, "caseDefinitionId": { "type": "string" }, "reachedBefore": { "type": "string", "format": "date-time" }, "reachedAfter": { "type": "string", "format": "date-time" } } }, "HistoricMilestoneInstanceQueryResource": { "type": "object" }, "HistoricMilestoneInstanceResponse": { "type": "object", "properties": { "id": { "type": "string", "example": "5" }, "name": { "type": "string", "example": "milestoneName" }, "elementId": { "type": "string", "example": "milestonePlanItemId" }, "timestamp": { "type": "string", "format": "date-time", "example": "2013-04-18T14:06:32.715+0000" }, "caseInstanceId": { "type": "string", "example": "12345" }, "caseDefinitionId": { "type": "string", "example": "oneMilestoneCase%3A1%3A4" }, "url": { "type": "string", "example": "http://localhost:8182/cmmn-history/historic-milestone-instances/5" }, "historicCaseInstanceUrl": { "type": "string", "example": "http://localhost:8182/cmmn-history/historic-case-instances/12345" }, "caseDefinitionUrl": { "type": "string", "example": "http://localhost:8182/cmmn-repository/case-definitions/oneMilestoneCase%3A1%3A4" } } }, "HistoricPlanItemInstanceQueryRequest": { "type": "object", "properties": { "start": { "type": "integer", "format": "int32" }, "size": { "type": "integer", "format": "int32" }, "sort": { "type": "string" }, "order": { "type": "string" }, "planItemInstanceId": { "type": "string" }, "planItemInstanceName": { "type": "string" }, "planItemInstanceState": { "type": "string" }, "caseDefinitionId": { "type": "string" }, "caseInstanceId": { "type": "string" }, "caseInstanceIds": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "stageInstanceId": { "type": "string" }, "elementId": { "type": "string" }, "planItemDefinitionId": { "type": "string" }, "planItemDefinitionType": { "type": "string" }, "createdBefore": { "type": "string", "format": "date-time" }, "createdAfter": { "type": "string", "format": "date-time" }, "lastAvailableBefore": { "type": "string", "format": "date-time" }, "lastAvailableAfter": { "type": "string", "format": "date-time" }, "lastEnabledBefore": { "type": "string", "format": "date-time" }, "lastEnabledAfter": { "type": "string", "format": "date-time" }, "lastDisabledBefore": { "type": "string", "format": "date-time" }, "lastDisabledAfter": { "type": "string", "format": "date-time" }, "lastStartedBefore": { "type": "string", "format": "date-time" }, "lastStartedAfter": { "type": "string", "format": "date-time" }, "lastSuspendedBefore": { "type": "string", "format": "date-time" }, "lastSuspendedAfter": { "type": "string", "format": "date-time" }, "completedBefore": { "type": "string", "format": "date-time" }, "completedAfter": { "type": "string", "format": "date-time" }, "terminatedBefore": { "type": "string", "format": "date-time" }, "terminatedAfter": { "type": "string", "format": "date-time" }, "occurredBefore": { "type": "string", "format": "date-time" }, "occurredAfter": { "type": "string", "format": "date-time" }, "exitBefore": { "type": "string", "format": "date-time" }, "exitAfter": { "type": "string", "format": "date-time" }, "endedBefore": { "type": "string", "format": "date-time" }, "endedAfter": { "type": "string", "format": "date-time" }, "startUserId": { "type": "string" }, "referenceId": { "type": "string" }, "referenceType": { "type": "string" }, "tenantId": { "type": "string" }, "withoutTenantId": { "type": "boolean" }, "includeLocalVariables": { "type": "boolean" } } }, "HistoricPlanItemInstanceQueryResource": { "type": "object" }, "HistoricPlanItemInstanceResponse": { "type": "object", "properties": { "id": { "type": "string", "example": "5" }, "name": { "type": "string", "example": "myPlanItemName" }, "state": { "type": "string", "example": "completed" }, "caseDefinitionId": { "type": "string", "example": "myCaseId%3A1%3A4" }, "derivedCaseDefinitionId": { "type": "string" }, "caseInstanceId": { "type": "string", "example": "12345" }, "stageInstanceId": { "type": "string", "example": "stageId" }, "stage": { "type": "boolean", "example": true }, "elementId": { "type": "string", "example": "someElementId" }, "planItemDefinitionId": { "type": "string", "example": "someId" }, "planItemDefinitionType": { "type": "string", "example": "timerEventListener" }, "createTime": { "type": "string", "format": "date-time", "example": "2013-04-17T10:17:43.902+0000" }, "lastAvailableTime": { "type": "string", "format": "date-time", "example": "2013-04-17T10:17:43.902+0000" }, "lastEnabledTime": { "type": "string", "format": "date-time", "example": "2013-04-17T10:17:43.902+0000" }, "lastDisabledTime": { "type": "string", "format": "date-time", "example": "2013-04-17T10:17:43.902+0000" }, "lastStartedTime": { "type": "string", "format": "date-time", "example": "2013-04-17T10:17:43.902+0000" }, "lastSuspendedTime": { "type": "string", "format": "date-time", "example": "2013-04-17T10:17:43.902+0000" }, "completedTime": { "type": "string", "format": "date-time", "example": "2013-04-17T10:17:43.902+0000" }, "occurredTime": { "type": "string", "format": "date-time", "example": "2013-04-17T10:17:43.902+0000" }, "terminatedTime": { "type": "string", "format": "date-time", "example": "2013-04-17T10:17:43.902+0000" }, "exitTime": { "type": "string", "format": "date-time", "example": "2013-04-17T10:17:43.902+0000" }, "endedTime": { "type": "string", "format": "date-time", "example": "2013-04-17T10:17:43.902+0000" }, "lastUpdatedTime": { "type": "string", "format": "date-time" }, "startUserId": { "type": "string", "example": "kermit" }, "assignee": { "type": "string" }, "completedBy": { "type": "string" }, "referenceId": { "type": "string", "example": "referenceId" }, "referenceType": { "type": "string", "example": "referenceType" }, "entryCriterionId": { "type": "string" }, "exitCriterionId": { "type": "string" }, "formKey": { "type": "string" }, "extraValue": { "type": "string" }, "showInOverview": { "type": "boolean" }, "tenantId": { "type": "string", "example": "null" }, "url": { "type": "string", "example": "http://localhost:8182/cmmn-history/historic-planitem-instances/5" }, "caseInstanceUrl": { "type": "string", "example": "http://localhost:8182/cmmn-history/historic-case-instances/12345" }, "caseDefinitionUrl": { "type": "string", "example": "http://localhost:8182/cmmn-repository/case-definitions/myCaseId%3A1%3A4" }, "derivedCaseDefinitionUrl": { "type": "string" }, "stageInstanceUrl": { "type": "string" }, "localVariables": { "type": "array", "items": { "$ref": "#/components/schemas/RestVariable" } } } }, "HistoricTaskInstanceQueryRequest": { "type": "object", "properties": { "start": { "type": "integer", "format": "int32" }, "size": { "type": "integer", "format": "int32" }, "sort": { "type": "string" }, "order": { "type": "string" }, "taskId": { "type": "string" }, "caseInstanceId": { "type": "string" }, "caseInstanceIdWithChildren": { "type": "string" }, "caseDefinitionId": { "type": "string" }, "caseDefinitionKey": { "type": "string" }, "caseDefinitionKeyLike": { "type": "string" }, "caseDefinitionKeyLikeIgnoreCase": { "type": "string" }, "caseDefinitionKeys": { "type": "array", "items": { "type": "string" } }, "planItemInstanceId": { "type": "string" }, "propagatedStageInstanceId": { "type": "string" }, "scopeId": { "type": "string" }, "scopeIds": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "withoutScopeId": { "type": "boolean" }, "taskName": { "type": "string" }, "taskNameLike": { "type": "string" }, "taskNameLikeIgnoreCase": { "type": "string" }, "taskDescription": { "type": "string" }, "taskDescriptionLike": { "type": "string" }, "taskDefinitionKey": { "type": "string" }, "taskDefinitionKeyLike": { "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" } }, "tenantId": { "type": "string" }, "tenantIdLike": { "type": "string" }, "withoutTenantId": { "type": "boolean" }, "withoutProcessInstanceId": { "type": "boolean" }, "taskCandidateGroup": { "type": "string" }, "ignoreTaskAssignee": { "type": "boolean" }, "rootScopeId": { "type": "string" }, "parentScopeId": { "type": "string" } } }, "HistoricTaskInstanceQueryResource": { "type": "object" }, "HistoricTaskInstanceResponse": { "type": "object", "properties": { "id": { "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" } }, "tenantId": { "type": "string" }, "category": { "type": "string" }, "caseInstanceId": { "type": "string" }, "caseInstanceUrl": { "type": "string" }, "caseDefinitionId": { "type": "string" }, "caseDefinitionUrl": { "type": "string" }, "scopeDefinitionId": { "type": "string" }, "scopeId": { "type": "string" }, "subScopeId": { "type": "string" }, "scopeType": { "type": "string" }, "propagatedStageInstanceId": { "type": "string" }, "executionId": { "type": "string" }, "processInstanceId": { "type": "string" }, "processDefinitionId": { "type": "string" } } }, "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" }, "planItemInstanceId": { "type": "string" }, "caseInstanceId": { "type": "string" }, "variableName": { "type": "string" }, "variableNameLike": { "type": "string" }, "variables": { "type": "array", "items": { "$ref": "#/components/schemas/QueryVariable" } }, "excludeLocalVariables": { "type": "boolean" } } }, "HistoricVariableInstanceResponse": { "type": "object", "properties": { "id": { "type": "string", "example": "14" }, "caseInstanceId": { "type": "string", "example": "5" }, "caseInstanceUrl": { "type": "string", "example": "http://localhost:8182/cmmn-history/historic-case-instances/5" }, "taskId": { "type": "string", "example": "6" }, "planItemInstanceId": { "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": "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" } } }, "JobResponse": { "type": "object", "properties": { "id": { "type": "string", "example": "8" }, "url": { "type": "string", "example": "http://localhost:8182/management/jobs/8" }, "caseInstanceId": { "type": "string", "example": "5" }, "caseInstanceUrl": { "type": "string", "example": "http://localhost:8182/cmmn-runtime/case-instances/5" }, "caseDefinitionId": { "type": "string", "example": "timerCase:1:4" }, "caseDefinitionUrl": { "type": "string", "example": "http://localhost:8182/cmmn-repository/case-definitions/timerCase%3A1%3A4" }, "planItemInstanceId": { "type": "string", "example": "7" }, "elementId": { "type": "string", "example": "scriptTask1" }, "elementName": { "type": "string", "example": "Script task" }, "handlerType": { "type": "string", "example": "cmmn-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" } } }, "ManualActivationRule": { "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" } } }, "documentationTextFormat": { "type": "string" }, "documentation": { "type": "string" }, "name": { "type": "string" }, "parent": { "$ref": "#/components/schemas/PlanFragment" }, "condition": { "type": "string" }, "parentStage": { "$ref": "#/components/schemas/Stage" } } }, "ParentCompletionRule": { "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" } } }, "documentationTextFormat": { "type": "string" }, "documentation": { "type": "string" }, "name": { "type": "string" }, "parent": { "$ref": "#/components/schemas/PlanFragment" }, "condition": { "type": "string" }, "type": { "type": "string" }, "parentStage": { "$ref": "#/components/schemas/Stage" } } }, "PlanFragment": { "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" } } }, "documentationTextFormat": { "type": "string" }, "documentation": { "type": "string" }, "name": { "type": "string" }, "parent": { "$ref": "#/components/schemas/PlanFragment" }, "planItemRef": { "type": "string" }, "defaultControl": { "$ref": "#/components/schemas/PlanItemControl" }, "lifecycleListeners": { "type": "array", "items": { "$ref": "#/components/schemas/FlowableListener" } }, "planItem": { "$ref": "#/components/schemas/PlanItem" }, "sentries": { "type": "array", "items": { "$ref": "#/components/schemas/Sentry" } }, "directChildPlanItemsWithLifecycleEnabled": { "type": "array", "items": { "$ref": "#/components/schemas/PlanItem" } }, "planItems": { "type": "array", "items": { "$ref": "#/components/schemas/PlanItem" } }, "case": { "$ref": "#/components/schemas/Case" }, "parentStage": { "$ref": "#/components/schemas/Stage" } } }, "PlanItem": { "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" } } }, "documentationTextFormat": { "type": "string" }, "documentation": { "type": "string" }, "name": { "type": "string" }, "parent": { "$ref": "#/components/schemas/PlanFragment" }, "definitionRef": { "type": "string" }, "planItemDefinition": { "$ref": "#/components/schemas/PlanItemDefinition" }, "instanceLifecycleEnabled": { "type": "boolean" }, "itemControl": { "$ref": "#/components/schemas/PlanItemControl" }, "criteriaRefs": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "entryCriteria": { "type": "array", "items": { "$ref": "#/components/schemas/Criterion" } }, "exitCriteria": { "type": "array", "items": { "$ref": "#/components/schemas/Criterion" } }, "incomingAssociations": { "type": "array", "items": { "$ref": "#/components/schemas/Association" } }, "outgoingAssociations": { "type": "array", "items": { "$ref": "#/components/schemas/Association" } }, "entryDependencies": { "type": "array", "items": { "$ref": "#/components/schemas/PlanItem" } }, "exitDependencies": { "type": "array", "items": { "$ref": "#/components/schemas/PlanItem" } }, "entryDependentPlanItems": { "type": "array", "items": { "$ref": "#/components/schemas/PlanItem" } }, "exitDependentPlanItems": { "type": "array", "items": { "$ref": "#/components/schemas/PlanItem" } }, "behavior": { "type": "object" }, "allDependentPlanItems": { "type": "array", "items": { "$ref": "#/components/schemas/PlanItem" } }, "parentStage": { "$ref": "#/components/schemas/Stage" } } }, "PlanItemControl": { "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" } } }, "documentationTextFormat": { "type": "string" }, "documentation": { "type": "string" }, "name": { "type": "string" }, "parent": { "$ref": "#/components/schemas/PlanFragment" }, "requiredRule": { "$ref": "#/components/schemas/RequiredRule" }, "repetitionRule": { "$ref": "#/components/schemas/RepetitionRule" }, "manualActivationRule": { "$ref": "#/components/schemas/ManualActivationRule" }, "completionNeutralRule": { "$ref": "#/components/schemas/CompletionNeutralRule" }, "parentCompletionRule": { "$ref": "#/components/schemas/ParentCompletionRule" }, "reactivationRule": { "$ref": "#/components/schemas/ReactivationRule" }, "parentStage": { "$ref": "#/components/schemas/Stage" } } }, "PlanItemDefinition": { "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" } } }, "documentationTextFormat": { "type": "string" }, "documentation": { "type": "string" }, "name": { "type": "string" }, "parent": { "$ref": "#/components/schemas/PlanFragment" }, "planItemRef": { "type": "string" }, "defaultControl": { "$ref": "#/components/schemas/PlanItemControl" }, "lifecycleListeners": { "type": "array", "items": { "$ref": "#/components/schemas/FlowableListener" } }, "parentStage": { "$ref": "#/components/schemas/Stage" } } }, "PlanItemDefinitionWithTargetIdsRequest": { "type": "object", "properties": { "existingPlanItemDefinitionId": { "type": "string" }, "newPlanItemId": { "type": "string" }, "newPlanItemDefinitionId": { "type": "string" } } }, "PlanItemInstanceQueryRequest": { "type": "object", "properties": { "start": { "type": "integer", "format": "int32" }, "size": { "type": "integer", "format": "int32" }, "sort": { "type": "string" }, "order": { "type": "string" }, "id": { "type": "string" }, "elementId": { "type": "string" }, "name": { "type": "string" }, "caseInstanceId": { "type": "string" }, "caseInstanceIds": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "caseDefinitionId": { "type": "string" }, "stageInstanceId": { "type": "string" }, "planItemDefinitionId": { "type": "string" }, "planItemDefinitionType": { "type": "string" }, "planItemDefinitionTypes": { "type": "array", "items": { "type": "string" } }, "state": { "type": "string" }, "createdBefore": { "type": "string", "format": "date-time" }, "createdAfter": { "type": "string", "format": "date-time" }, "startUserId": { "type": "string" }, "referenceId": { "type": "string" }, "referenceType": { "type": "string" }, "includeEnded": { "type": "boolean" }, "includeLocalVariables": { "type": "boolean" }, "variables": { "type": "array", "items": { "$ref": "#/components/schemas/QueryVariable" } }, "caseInstanceVariables": { "type": "array", "items": { "$ref": "#/components/schemas/QueryVariable" } }, "tenantId": { "type": "string" }, "withoutTenantId": { "type": "boolean" } } }, "PlanItemInstanceQueryResource": { "type": "object" }, "PlanItemInstanceResponse": { "type": "object", "properties": { "id": { "type": "string", "example": "5" }, "url": { "type": "string", "example": "http://localhost:8182/cmmn-runtime/plan-item-instances/5" }, "name": { "type": "string" }, "caseInstanceId": { "type": "string" }, "caseInstanceUrl": { "type": "string" }, "caseDefinitionId": { "type": "string" }, "caseDefinitionUrl": { "type": "string" }, "derivedCaseDefinitionId": { "type": "string" }, "derivedCaseDefinitionUrl": { "type": "string" }, "stageInstanceId": { "type": "string" }, "stageInstanceUrl": { "type": "string" }, "planItemDefinitionId": { "type": "string" }, "planItemDefinitionType": { "type": "string" }, "state": { "type": "string" }, "stage": { "type": "boolean" }, "elementId": { "type": "string" }, "createTime": { "type": "string", "format": "date-time" }, "lastAvailableTime": { "type": "string", "format": "date-time" }, "lastEnabledTime": { "type": "string", "format": "date-time" }, "lastDisabledTime": { "type": "string", "format": "date-time" }, "lastStartedTime": { "type": "string", "format": "date-time" }, "lastSuspendedTime": { "type": "string", "format": "date-time" }, "completedTime": { "type": "string", "format": "date-time" }, "occurredTime": { "type": "string", "format": "date-time" }, "terminatedTime": { "type": "string", "format": "date-time" }, "exitTime": { "type": "string", "format": "date-time" }, "endedTime": { "type": "string", "format": "date-time" }, "startUserId": { "type": "string" }, "assignee": { "type": "string" }, "completedBy": { "type": "string" }, "referenceId": { "type": "string" }, "referenceType": { "type": "string" }, "completable": { "type": "boolean" }, "entryCriterionId": { "type": "string" }, "exitCriterionId": { "type": "string" }, "formKey": { "type": "string" }, "extraValue": { "type": "string" }, "tenantId": { "type": "string", "example": "null" }, "localVariables": { "type": "array", "items": { "$ref": "#/components/schemas/RestVariable" } } } }, "PlanItemInstanceVariableCollectionResource": { "type": "object" }, "PlanItemInstanceVariableResource": { "type": "object" }, "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" } } }, "documentationTextFormat": { "type": "string" }, "documentation": { "type": "string" }, "name": { "type": "string" }, "externalRef": { "type": "string" }, "implementationType": { "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" } } }, "ReactivateEventListener": { "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" } } }, "documentationTextFormat": { "type": "string" }, "documentation": { "type": "string" }, "name": { "type": "string" }, "parent": { "$ref": "#/components/schemas/PlanFragment" }, "planItemRef": { "type": "string" }, "defaultControl": { "$ref": "#/components/schemas/PlanItemControl" }, "lifecycleListeners": { "type": "array", "items": { "$ref": "#/components/schemas/FlowableListener" } }, "availableConditionExpression": { "type": "string" }, "authorizedRoleRefs": { "type": "array", "items": { "type": "string" } }, "defaultReactivationRule": { "$ref": "#/components/schemas/ReactivationRule" }, "reactivationAvailableConditionExpression": { "type": "string" }, "parentStage": { "$ref": "#/components/schemas/Stage" } } }, "ReactivationRule": { "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" } } }, "documentationTextFormat": { "type": "string" }, "documentation": { "type": "string" }, "name": { "type": "string" }, "parent": { "$ref": "#/components/schemas/PlanFragment" }, "condition": { "type": "string" }, "activateCondition": { "type": "string" }, "ignoreCondition": { "type": "string" }, "defaultCondition": { "type": "string" }, "parentStage": { "$ref": "#/components/schemas/Stage" } } }, "RepetitionRule": { "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" } } }, "documentationTextFormat": { "type": "string" }, "documentation": { "type": "string" }, "name": { "type": "string" }, "parent": { "$ref": "#/components/schemas/PlanFragment" }, "condition": { "type": "string" }, "repetitionCounterVariableName": { "type": "string" }, "ignoreRepetitionCounterVariable": { "type": "boolean" }, "collectionVariableName": { "type": "string" }, "elementVariableName": { "type": "string" }, "elementIndexVariableName": { "type": "string" }, "maxInstanceCount": { "type": "integer", "format": "int32" }, "aggregations": { "$ref": "#/components/schemas/VariableAggregationDefinitions" }, "parentStage": { "$ref": "#/components/schemas/Stage" } } }, "RequiredRule": { "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" } } }, "documentationTextFormat": { "type": "string" }, "documentation": { "type": "string" }, "name": { "type": "string" }, "parent": { "$ref": "#/components/schemas/PlanFragment" }, "condition": { "type": "string" }, "parentStage": { "$ref": "#/components/schemas/Stage" } } }, "RestActionRequest": { "type": "object", "properties": { "action": { "type": "string" } } }, "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" } } }, "Sentry": { "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" } } }, "documentationTextFormat": { "type": "string" }, "documentation": { "type": "string" }, "name": { "type": "string" }, "parent": { "$ref": "#/components/schemas/PlanFragment" }, "triggerMode": { "type": "string" }, "onParts": { "type": "array", "items": { "$ref": "#/components/schemas/SentryOnPart" } }, "sentryIfPart": { "$ref": "#/components/schemas/SentryIfPart" }, "defaultTriggerMode": { "type": "boolean" }, "onEventTriggerMode": { "type": "boolean" }, "parentStage": { "$ref": "#/components/schemas/Stage" } } }, "SentryIfPart": { "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" } } }, "documentationTextFormat": { "type": "string" }, "documentation": { "type": "string" }, "condition": { "type": "string" } } }, "SentryOnPart": { "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" } } }, "documentationTextFormat": { "type": "string" }, "documentation": { "type": "string" }, "name": { "type": "string" }, "sourceRef": { "type": "string" }, "source": { "$ref": "#/components/schemas/PlanItem" }, "standardEvent": { "type": "string" } } }, "Stage": { "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" } } }, "documentationTextFormat": { "type": "string" }, "documentation": { "type": "string" }, "name": { "type": "string" }, "parent": { "$ref": "#/components/schemas/PlanFragment" }, "planItemRef": { "type": "string" }, "defaultControl": { "$ref": "#/components/schemas/PlanItemControl" }, "lifecycleListeners": { "type": "array", "items": { "$ref": "#/components/schemas/FlowableListener" } }, "planItem": { "$ref": "#/components/schemas/PlanItem" }, "sentries": { "type": "array", "items": { "$ref": "#/components/schemas/Sentry" } }, "exitCriteria": { "type": "array", "items": { "$ref": "#/components/schemas/Criterion" } }, "autoComplete": { "type": "boolean" }, "autoCompleteCondition": { "type": "string" }, "formKey": { "type": "string" }, "sameDeployment": { "type": "boolean" }, "validateFormFields": { "type": "string" }, "displayOrder": { "type": "integer", "format": "int32" }, "includeInStageOverview": { "type": "string" }, "planItemDefinitionMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PlanItemDefinition" } }, "businessStatus": { "type": "string" }, "planModel": { "type": "boolean" }, "planItemDefinitions": { "type": "array", "items": { "$ref": "#/components/schemas/PlanItemDefinition" } }, "directChildPlanItemsWithLifecycleEnabled": { "type": "array", "items": { "$ref": "#/components/schemas/PlanItem" } }, "planItems": { "type": "array", "items": { "$ref": "#/components/schemas/PlanItem" } }, "case": { "$ref": "#/components/schemas/Case" }, "parentStage": { "$ref": "#/components/schemas/Stage" } } }, "StageResponse": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "ended": { "type": "boolean" }, "endTime": { "type": "string", "format": "date-time" }, "current": { "type": "boolean" } } }, "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" } } } }, "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" }, "caseInstanceId": { "type": "string" }, "caseInstanceIdWithChildren": { "type": "string" }, "planItemInstanceId": { "type": "string" }, "propagatedStageInstanceId": { "type": "string" }, "scopeId": { "type": "string" }, "scopeIds": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "withoutScopeId": { "type": "boolean" }, "subScopeId": { "type": "string" }, "scopeType": { "type": "string" }, "caseDefinitionId": { "type": "string" }, "caseDefinitionKey": { "type": "string" }, "caseDefinitionKeyLike": { "type": "string" }, "caseDefinitionKeyLikeIgnoreCase": { "type": "string" }, "caseDefinitionKeys": { "type": "array", "items": { "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" }, "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" }, "tenantId": { "type": "string" }, "tenantIdLike": { "type": "string" }, "withoutTenantId": { "type": "boolean" }, "withoutProcessInstanceId": { "type": "boolean" }, "candidateOrAssigned": { "type": "string" }, "category": { "type": "string" }, "rootScopeId": { "type": "string" }, "parentScopeId": { "type": "string" }, "taskVariables": { "type": "array", "items": { "$ref": "#/components/schemas/QueryVariable" } }, "categoryIn": { "type": "array", "items": { "type": "string" } }, "categoryNotIn": { "type": "array", "items": { "type": "string" } }, "withoutCategory": { "type": "boolean" } } }, "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/cmmn-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": "2013-04-17T10:17:43.902+0000" }, "dueDate": { "type": "string", "format": "date-time", "example": "2013-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": "123" }, "scopeId": { "type": "string", "example": "123" }, "subScopeId": { "type": "string", "example": "123" }, "scopeType": { "type": "string", "example": "cmmn" }, "propagatedStageInstanceId": { "type": "string", "example": "123" }, "tenantId": { "type": "string", "example": "null" }, "category": { "type": "string", "example": "ExampleCategory" }, "formKey": { "type": "string" }, "caseInstanceId": { "type": "string", "example": "5" }, "caseInstanceUrl": { "type": "string", "example": "http://localhost:8182/cmmn-runtime/case-instances/5" }, "caseDefinitionId": { "type": "string", "example": "oneTaskCase%3A1%3A4" }, "caseDefinitionUrl": { "type": "string", "example": "http://localhost:8182/cmmn-runtime/case-definitions/oneTaskCase%3A1%3A4" }, "parentTaskId": { "type": "string", "example": "null" }, "parentTaskUrl": { "type": "string", "example": "null" }, "executionId": { "type": "string", "example": "123" }, "processInstanceId": { "type": "string", "example": "123" }, "processDefinitionId": { "type": "string", "example": "123" }, "variables": { "type": "array", "items": { "$ref": "#/components/schemas/RestVariable" } } } }, "TaskVariableCollectionResource": { "type": "object" }, "TaskVariableResource": { "type": "object" }, "TextAnnotation": { "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" } } }, "documentationTextFormat": { "type": "string" }, "documentation": { "type": "string" }, "text": { "type": "string" }, "textFormat": { "type": "string" } } }, "TimerJobActionRequest": { "type": "object", "properties": { "action": { "type": "string" }, "dueDate": { "type": "string" } } }, "Variable": { "type": "object", "properties": { "source": { "type": "string" }, "target": { "type": "string" }, "targetExpression": { "type": "string" }, "sourceExpression": { "type": "string" } } }, "VariableAggregationDefinition": { "type": "object", "properties": { "implementationType": { "type": "string" }, "implementation": { "type": "string" }, "target": { "type": "string" }, "targetExpression": { "type": "string" }, "definitions": { "type": "array", "items": { "$ref": "#/components/schemas/Variable" } }, "storeAsTransientVariable": { "type": "boolean" }, "createOverviewVariable": { "type": "boolean" } } }, "VariableAggregationDefinitions": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/VariableAggregationDefinition" } }, "overviewAggregations": { "type": "array", "items": { "$ref": "#/components/schemas/VariableAggregationDefinition" } } } }, "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" }, "planItemInstanceId": { "type": "string" }, "caseInstanceId": { "type": "string" }, "variableName": { "type": "string" }, "variableNameLike": { "type": "string" }, "variables": { "type": "array", "items": { "$ref": "#/components/schemas/QueryVariable" } }, "excludeLocalVariables": { "type": "boolean" }, "variableScope": { "type": "string" } } }, "VariableInstanceResponse": { "type": "object", "properties": { "id": { "type": "string", "example": "14" }, "caseInstanceId": { "type": "string", "example": "5" }, "caseInstanceUrl": { "type": "string", "example": "http://localhost:8182/cmmn-history/historic-case-instances/5" }, "taskId": { "type": "string", "example": "6" }, "planItemInstanceId": { "type": "string" }, "variable": { "$ref": "#/components/schemas/RestVariable" } } } } }