--- swagger: "2.0" info: description: "Note: the Flowable Inspect REST API is a not a public API.\nThis means\ \ that there are no backward compatibility guarantees on using any of the API's\ \ here." version: "v1" title: "Flowable Inspect REST API" contact: name: "Flowable" url: "http://www.flowable.com/" host: "localhost:8090" basePath: "/inspect-api" tags: - name: "Definitions" - name: "Event Registry" - name: "Inspect" - name: "User Definitions" schemes: - "http" - "https" paths: /activity-instances: get: tags: - "Inspect" summary: "Get activity instances" description: "" operationId: "getActivityInstances" produces: - "application/json" parameters: - name: "scopeId" in: "query" description: "Unique identifier of a scope" required: true type: "string" responses: 200: description: "successful operation" schema: type: "array" items: $ref: "#/definitions/ActivityInstanceDTO" security: - basicAuth: [] /agent-instances: get: tags: - "Inspect" summary: "Get agent instances" description: "" operationId: "getAgentInstances" produces: - "application/json" parameters: - in: "body" name: "scopeId" description: "Unique identifier of a scope" required: false schema: type: "string" - in: "body" name: "scopeType" description: "The type of scope (e.g. bpmn, cmmn)" required: false schema: type: "string" responses: 200: description: "successful operation" schema: type: "array" items: $ref: "#/definitions/AgentInstanceDTO" security: - basicAuth: [] /agent-invocation-exchanges: get: tags: - "Inspect" summary: "Get agent invocation exchanges" description: "" operationId: "getAgentInvocationExchanges" produces: - "application/json" parameters: - in: "body" name: "agentInstanceId" description: "Unique identifier of an agent instance" required: false schema: type: "string" responses: 200: description: "successful operation" schema: type: "array" items: $ref: "#/definitions/AgentInvocationExchangeDTO" security: - basicAuth: [] /agent-invocation-exchanges/{exchangeId}/parts: get: tags: - "Inspect" summary: "Get agent invocation exchange parts" description: "" operationId: "getAgentInvocationExchangeParts" produces: - "application/json" parameters: - name: "exchangeId" in: "path" description: "Unique identifier of an exchange" required: true type: "string" responses: 200: description: "successful operation" schema: type: "array" items: $ref: "#/definitions/AgentInvocationExchangePartDTO" security: - basicAuth: [] /agent-invocations: get: tags: - "Inspect" summary: "Get agent invocations" description: "" operationId: "getAgentInvocations" produces: - "application/json" parameters: - in: "body" name: "agentInstanceId" description: "Unique identifier of an agent instance" required: false schema: type: "string" responses: 200: description: "successful operation" schema: type: "array" items: $ref: "#/definitions/AgentInvocationDTO" security: - basicAuth: [] /case-instances/{id}: get: tags: - "Inspect" summary: "Get case instance information" description: "" operationId: "getCaseInstanceInfo" produces: - "application/json" parameters: - name: "caseInstanceId" in: "path" description: "Unique identifier of the case instance" required: true type: "string" - name: "detailed" in: "query" required: false type: "boolean" responses: 200: description: "Indicates the case instance information was found and returned." schema: $ref: "#/definitions/CaseInstanceInfoDTO" 403: description: "Indicates the user does not have the rights to query for the\ \ case instance." 404: description: "Indicates the requested case instance was not found." security: - basicAuth: [] /case-instances/{id}/migrate: post: tags: - "Inspect" summary: "Migrate case instance" description: "" operationId: "migrateCaseInstance" parameters: - name: "caseInstanceId" in: "path" description: "Unique identifier of the case instance" required: true type: "string" responses: 204: description: "" security: - basicAuth: [] /current-instance: get: tags: - "Inspect" summary: "Get current instance" description: "" operationId: "getCurrentInstance" produces: - "application/json" parameters: - name: "scopeId" in: "query" description: "Scope id for the current instance" required: true type: "string" - name: "scopeType" in: "query" description: "Scope type for the current instance" required: true type: "string" responses: 200: description: "successful operation" schema: $ref: "#/definitions/CurrentInstanceDTO" security: - basicAuth: [] /current-instance/{scopeId}/breakpoint-definitions: post: tags: - "Inspect" summary: "Create a new breakpoint definition for the current instance" description: "" operationId: "createBreakpointDefinitionForCurrentInstance" produces: - "application/json" parameters: - name: "scopeId" in: "path" required: true type: "string" - in: "body" name: "body" required: false schema: $ref: "#/definitions/CreateBreakpointDefinitionDTO" responses: 200: description: "Indicates the breakpoint definitions is created and returned." schema: $ref: "#/definitions/BreakpointDefinitionDTO" 403: description: "Indicates the user does not have the rights to create a breakpoint\ \ definition." 404: description: "Indicates the requested current instance was not found." 409: description: "Indicates there was already a breakpoint created for the same\ \ activity." security: - basicAuth: [] /current-instance/{scopeId}/breakpoint-definitions/{activityId}: delete: tags: - "Inspect" summary: "Delete a breakpoint definition for the current instance" description: "" operationId: "deleteBreakpointDefinition" produces: - "application/json" parameters: - name: "scopeId" in: "path" required: true type: "string" - name: "activityId" in: "path" required: true type: "string" - name: "scopeType" in: "query" required: true type: "string" - name: "actionId" in: "query" required: true type: "string" responses: 200: description: "Indicates the breakpoint definitions is deleted." 403: description: "Indicates the user does not have the rights to delete the\ \ breakpoint definition." 404: description: "Indicates the requested current instance was not found." security: - basicAuth: [] /current-instance/{scopeId}/breakpoint-instances/{breakpointInstanceId}: post: tags: - "Inspect" summary: "Continue an existing breakpoint for the current instance" description: "" operationId: "continueBreakpointForCurrentInstance" produces: - "application/json" parameters: - name: "scopeId" in: "path" required: true type: "string" - name: "breakpointInstanceId" in: "path" required: true type: "string" - name: "scopeType" in: "query" required: true type: "string" - in: "body" name: "body" required: false schema: $ref: "#/definitions/ContinueBreakpointInstanceDTO" responses: 200: description: "Indicates the breakpoint was continued" 403: description: "Indicates the user does not have the rights to continue the\ \ breakpoint." 404: description: "Indicates the requested current instance was not found." security: - basicAuth: [] /deadletter-jobs: get: tags: - "Inspect" summary: "Get dead letter jobs jobs" description: "" operationId: "getDeadLetterJobs" produces: - "application/json" parameters: - name: "scopeId" in: "query" description: "Unique identifier of a scope" required: true type: "string" - name: "scopeType" in: "query" description: "Type of the scope" required: true type: "string" responses: 200: description: "Indicates the dead letter jobs are found and returned." schema: type: "array" items: $ref: "#/definitions/DeadLetterJobDTO" security: - basicAuth: [] /decision-execution-info/{executionId}/{activityId}: get: tags: - "Inspect" summary: "Get decision execution info" description: "" operationId: "getDecisionExecutionInfo" produces: - "application/json" parameters: - name: "executionId" in: "path" description: "Execution id of the decision execution" required: true type: "string" - name: "activityId" in: "path" description: "Activity id of the decision execution" required: true type: "string" responses: 200: description: "successful operation" schema: $ref: "#/definitions/DecisionExecutionDTO" security: - basicAuth: [] /decision-execution/{decisionExecutionId}/auditdata: get: tags: - "Inspect" summary: "Get decision execution audit data" description: "" operationId: "getDecisionExecutionAuditData" produces: - "application/json" parameters: - name: "decisionExecutionId" in: "path" description: "Decision execution id" required: true type: "string" responses: 200: description: "successful operation" schema: type: "string" security: - basicAuth: [] /decision-execution/{decisionExecutionId}/model: get: tags: - "Inspect" summary: "Get decision execution model" description: "" operationId: "getDecisionExecutionModel" produces: - "application/json" parameters: - name: "decisionExecutionId" in: "path" description: "Decision execution id" required: true type: "string" responses: 200: description: "successful operation" schema: $ref: "#/definitions/DmnDefinition" security: - basicAuth: [] /entity-links: get: tags: - "Inspect" summary: "Get entity links" description: "" operationId: "getEntityLinks" produces: - "application/json" parameters: - name: "scopeId" in: "query" description: "Unique identifier of a scope" required: true type: "string" - name: "scopeType" in: "query" description: "Type of the scope" required: true type: "string" responses: 200: description: "Indicates the entity links are found and returned." schema: $ref: "#/definitions/EntityLinkDTO" 403: description: "Indicates the user does not have the rights to query for the\ \ entity links." 404: description: "Indicates the referenced instance is not found." security: - basicAuth: [] /evaluate-expression: post: tags: - "Inspect" summary: "Evaluate expression" description: "" operationId: "evaluateExpression" produces: - "application/json" parameters: - in: "body" name: "body" required: false schema: $ref: "#/definitions/EvaluateExpressionDTO" responses: 200: description: "successful operation" schema: $ref: "#/definitions/ExpressionValueDTO" security: - basicAuth: [] /event-registry-events: get: tags: - "Inspect" summary: "Get event registry events" description: "" operationId: "getEventRegistryEvents" produces: - "application/json" parameters: - name: "scopeId" in: "query" description: "Unique identifier of a scope" required: true type: "string" - name: "scopeType" in: "query" description: "Type of the scope" required: true type: "string" responses: 200: description: "Indicates the event registry events are found and returned." schema: type: "array" items: $ref: "#/definitions/EventSubscriptionDTO" security: - basicAuth: [] /event-registry-events/{id}: post: tags: - "Inspect" summary: "Trigger event registry event" description: "" operationId: "triggerEventRegistryEvent" produces: - "application/json" parameters: - name: "eventId" in: "path" description: "Unique identifier of the event registry event" required: true type: "string" - in: "body" name: "body" required: false schema: $ref: "#/definitions/SendEventRequest" responses: 200: description: "Indicates the event registry event is found and triggered." schema: $ref: "#/definitions/TriggerResultDTO" 404: description: "Indicates the event registry event was not found." security: - basicAuth: [] /event-registry/channel-definitions: get: tags: - "Inspect" - "Event Registry" summary: "Get channel definitions" description: "" operationId: "listChannelDefinitions" produces: - "application/json" parameters: - name: "order" in: "query" description: "From the paginate request. The sort order, either 'asc' or\ \ 'desc'. Defaults to 'asc'." required: false type: "string" - name: "size" in: "query" description: "From the paginate request. Number of rows to fetch, starting\ \ from start. Defaults to 10." required: false type: "integer" format: "int32" - name: "sort" in: "query" description: "Property to sort the results on" required: false type: "string" - name: "start" in: "query" description: "From the paginate request. Index of the first row to fetch.\ \ Defaults to 0." required: false type: "integer" format: "int32" - name: "type" in: "query" description: "" required: true type: "string" responses: 200: description: "Indicates the definitions were found and returned." schema: $ref: "#/definitions/DataResponseChannelDefinitionResponse" security: - basicAuth: [] /event-registry/channel-definitions/key/{key}/model: get: tags: - "Inspect" - "Event Registry" summary: "Get channel definition by key" description: "" operationId: "getChannelModel" produces: - "application/json" parameters: - name: "key" in: "path" required: true type: "string" responses: 200: description: "Indicates the definition was found and returned." schema: $ref: "#/definitions/ChannelModel" security: - basicAuth: [] /event-registry/event-definitions: get: tags: - "Inspect" - "Event Registry" summary: "Get event definitions" description: "" operationId: "listEventDefinitions" produces: - "application/json" parameters: - name: "keyLikeIgnoreCase" in: "query" description: "Only return event definitions with a key like the given value,\ \ ignoring the case" required: false type: "string" - name: "nameLikeIgnoreCase" in: "query" description: "Only return event definitions with a name like the given value,\ \ ignoring the case" required: false type: "string" - name: "order" in: "query" description: "From the paginate request. The sort order, either 'asc' or\ \ 'desc'. Defaults to 'asc'." required: false type: "string" - name: "size" in: "query" description: "From the paginate request. Number of rows to fetch, starting\ \ from start. Defaults to 10." required: false type: "integer" format: "int32" - name: "sort" in: "query" description: "Property to sort the results on" required: false type: "string" - name: "start" in: "query" description: "From the paginate request. Index of the first row to fetch.\ \ Defaults to 0." required: false type: "integer" format: "int32" responses: 200: description: "Indicates the definitions were found and returned." schema: $ref: "#/definitions/DataResponseEventDefinitionResponse" security: - basicAuth: [] /event-registry/event-definitions/key/{key}/model: get: tags: - "Inspect" - "Event Registry" summary: "Get event definition by key" description: "" operationId: "getEventModel" produces: - "application/json" parameters: - name: "key" in: "path" required: true type: "string" responses: 200: description: "Indicates the definition was found and returned." schema: $ref: "#/definitions/EventModel" security: - basicAuth: [] /event-registry/event-instances: post: tags: - "Inspect" - "Event Registry" summary: "Send an event" description: "" operationId: "sendEvent" parameters: - in: "body" name: "body" required: false schema: $ref: "#/definitions/SendEventRequest" responses: 204: description: "Indicates the event was send." schema: type: "object" security: - basicAuth: [] /execute-test: post: tags: - "Inspect" summary: "Execute a test with supporting models" description: "" operationId: "executeTestWithModels" produces: - "application/json" parameters: - in: "body" name: "body" required: false schema: $ref: "#/definitions/ExecuteTestRequest" responses: 200: description: "successful operation" schema: $ref: "#/definitions/TestRunInfoDTO" security: - basicAuth: [] /execute-test-model-content: post: tags: - "Inspect" summary: "Execute a test model from content" description: "" operationId: "executeTestModelContent" produces: - "application/json" parameters: - in: "body" name: "body" required: false schema: $ref: "#/definitions/TestModelDTO" responses: 200: description: "successful operation" schema: $ref: "#/definitions/TestRunInfoDTO" security: - basicAuth: [] /executions: get: tags: - "Inspect" summary: "Get executions" description: "" operationId: "getExecutions" produces: - "application/json" parameters: - name: "scopeId" in: "query" description: "Unique identifier of a scope" required: true type: "string" responses: 200: description: "Indicates the executions are found and returned." schema: type: "array" items: $ref: "#/definitions/ExecutionDTO" security: - basicAuth: [] /import-inflight-test-model: post: tags: - "Inspect" summary: "Import inflight test model" description: "" operationId: "importTestModel" produces: - "application/json" parameters: - name: "file" in: "query" required: true type: "ref" responses: 200: description: "successful operation" schema: $ref: "#/definitions/TestModelDTO" security: - basicAuth: [] /inflight-test-models: get: tags: - "Inspect" summary: "Get inflight test rows (one per test set, or one per test file for\ \ non-service / empty models)" description: "" operationId: "getTestModels" produces: - "application/json" parameters: - name: "scopeDefinitionKey" in: "query" description: "scope definition key" required: false type: "string" - name: "scopeType" in: "query" description: "scope type" required: false type: "string" responses: 200: description: "successful operation" schema: type: "array" items: $ref: "#/definitions/InflightTestRowDTO" security: - basicAuth: [] delete: tags: - "Inspect" summary: "Delete all inflight test models" description: "" operationId: "deleteAllTestModels" produces: - "application/json" parameters: - name: "deleteAll" in: "query" description: "Request parameter to delete all test models" required: true type: "string" responses: 204: description: "" security: - basicAuth: [] /inflight-test-models/apps: get: tags: - "Inspect" summary: "List apps that own test models" description: "" operationId: "listTestApps" produces: - "application/json" parameters: - name: "tenantId" in: "query" description: "Super admins only: scope the listing to this tenant; omitted\ \ lists across all tenants" required: false type: "string" - name: "order" in: "query" description: "From the paginate request. The sort order, either 'asc' or\ \ 'desc'. Defaults to 'asc'." required: false type: "string" - name: "size" in: "query" description: "From the paginate request. Number of rows to fetch, starting\ \ from start. Defaults to 10." required: false type: "integer" format: "int32" - name: "sort" in: "query" description: "Property to sort the results on" required: false type: "string" - name: "start" in: "query" description: "From the paginate request. Index of the first row to fetch.\ \ Defaults to 0." required: false type: "integer" format: "int32" responses: 200: description: "successful operation" schema: $ref: "#/definitions/DataResponseBulkTestAppDTO" security: - basicAuth: [] /inflight-test-models/test-instances/latest: get: tags: - "Inspect" summary: "Latest TestInstance summary per (testModelId, testSetKey)" description: "" operationId: "getLatestTestInstancesPerTestSet" produces: - "application/json" parameters: - name: "testModelIds" in: "query" description: "Comma-separated test model ids; the response contains one entry\ \ per (testModelId, testSetKey) with the most recent TestInstance." required: true type: "array" items: type: "string" collectionFormat: "multi" responses: 200: description: "successful operation" schema: type: "array" items: $ref: "#/definitions/TestInstanceDTO" security: - basicAuth: [] /inflight-test-models/test-runs: get: tags: - "Inspect" summary: "List bulk test runs" description: "" operationId: "listTestRuns" produces: - "application/json" parameters: - name: "status" in: "query" required: false type: "string" - name: "tenantId" in: "query" description: "Super admins only: scope the listing to this tenant; omitted\ \ lists across all tenants" required: false type: "string" - name: "order" in: "query" description: "From the paginate request. The sort order, either 'asc' or\ \ 'desc'. Defaults to 'asc'." required: false type: "string" - name: "size" in: "query" description: "From the paginate request. Number of rows to fetch, starting\ \ from start. Defaults to 10." required: false type: "integer" format: "int32" - name: "sort" in: "query" description: "Property to sort the results on" required: false type: "string" - name: "start" in: "query" description: "From the paginate request. Index of the first row to fetch.\ \ Defaults to 0." required: false type: "integer" format: "int32" responses: 200: description: "successful operation" schema: $ref: "#/definitions/DataResponseTestRunDTO" security: - basicAuth: [] post: tags: - "Inspect" summary: "Trigger an asynchronous bulk test run via filter" description: "" operationId: "triggerBulkTestRun" produces: - "application/json" parameters: - in: "body" name: "body" required: false schema: $ref: "#/definitions/BulkTestRunRequest" responses: 200: description: "successful operation" schema: $ref: "#/definitions/TestRunDTO" 202: description: "" security: - basicAuth: [] /inflight-test-models/test-runs/{testRunId}: get: tags: - "Inspect" summary: "Get a bulk test run" description: "" operationId: "getTestRun" produces: - "application/json" parameters: - name: "testRunId" in: "path" required: true type: "string" responses: 200: description: "successful operation" schema: $ref: "#/definitions/TestRunDTO" security: - basicAuth: [] /inflight-test-models/test-runs/{testRunId}/results: get: tags: - "Inspect" summary: "List per-test results for a bulk test run" description: "" operationId: "listTestRunResults" produces: - "application/json" parameters: - name: "testRunId" in: "path" required: true type: "string" - name: "status" in: "query" required: false type: "string" - name: "order" in: "query" description: "From the paginate request. The sort order, either 'asc' or\ \ 'desc'. Defaults to 'asc'." required: false type: "string" - name: "size" in: "query" description: "From the paginate request. Number of rows to fetch, starting\ \ from start. Defaults to 10." required: false type: "integer" format: "int32" - name: "sort" in: "query" description: "Property to sort the results on" required: false type: "string" - name: "start" in: "query" description: "From the paginate request. Index of the first row to fetch.\ \ Defaults to 0." required: false type: "integer" format: "int32" responses: 200: description: "successful operation" schema: $ref: "#/definitions/DataResponseTestInstanceDTO" security: - basicAuth: [] /inflight-test-models/{inflightTestModelId}: get: tags: - "Inspect" summary: "Get inflight test model" description: "" operationId: "getTestModel" produces: - "application/json" parameters: - name: "inflightTestModelId" in: "path" description: "id of the test model" required: true type: "string" responses: 200: description: "successful operation" schema: $ref: "#/definitions/TestModelDTO" security: - basicAuth: [] put: tags: - "Inspect" summary: "Save inflight test model" description: "" operationId: "saveTestModel" produces: - "application/json" parameters: - name: "inflightTestModelId" in: "path" description: "id of the test model" required: true type: "string" - in: "body" name: "body" required: false schema: $ref: "#/definitions/UpdateInflightTestModelDTO" responses: 200: description: "" security: - basicAuth: [] delete: tags: - "Inspect" summary: "Delete inflight test model" description: "" operationId: "deleteTestModel" produces: - "application/json" parameters: - name: "inflightTestModelId" in: "path" description: "id of the test model" required: true type: "string" responses: 204: description: "" security: - basicAuth: [] /inflight-test-models/{inflightTestModelId}/action: post: tags: - "Inspect" summary: "Add an action to a test model" description: "" operationId: "addTestAction" produces: - "application/json" parameters: - name: "inflightTestModelId" in: "path" description: "id of the test model" required: true type: "string" - in: "body" name: "body" required: false schema: $ref: "#/definitions/TestActionDTO" - name: "activityId" in: "query" description: "Activity id for the test step" required: true type: "string" - name: "executionId" in: "query" description: "Execution id for the test step" required: false type: "string" responses: 200: description: "" security: - basicAuth: [] /inflight-test-models/{inflightTestModelId}/action-types: get: tags: - "Inspect" summary: "Get action types for step object" description: "" operationId: "getActionTypes" produces: - "application/json" parameters: - name: "inflightTestModelId" in: "path" description: "id of the test model" required: true type: "string" - name: "activityId" in: "query" description: "Activity id for the test step" required: true type: "string" - name: "executionId" in: "query" description: "Execution id for the test step" required: false type: "string" responses: 200: description: "successful operation" schema: type: "array" items: $ref: "#/definitions/TestActionTypeDTO" security: - basicAuth: [] /inflight-test-models/{inflightTestModelId}/action/{actionId}: put: tags: - "Inspect" summary: "Update an action in a test model" description: "" operationId: "updateTestAction" produces: - "application/json" parameters: - name: "inflightTestModelId" in: "path" description: "id of the test model" required: true type: "string" - name: "actionId" in: "path" description: "id of the test action" required: true type: "string" - in: "body" name: "body" required: false schema: $ref: "#/definitions/TestActionDTO" - name: "activityId" in: "query" description: "Activity id for the test step" required: true type: "string" - name: "executionId" in: "query" description: "Execution id for the test step" required: false type: "string" responses: 200: description: "" security: - basicAuth: [] delete: tags: - "Inspect" summary: "Delete an action from a test model" description: "" operationId: "deleteTestAction" produces: - "application/json" parameters: - name: "inflightTestModelId" in: "path" description: "id of the test model" required: true type: "string" - name: "actionId" in: "path" description: "id of the test action" required: true type: "string" - name: "activityId" in: "query" description: "Activity id for the test step" required: true type: "string" - name: "executionId" in: "query" description: "Execution id for the test step" required: false type: "string" responses: 200: description: "" security: - basicAuth: [] /inflight-test-models/{inflightTestModelId}/breakpoint-definitions: get: tags: - "Inspect" summary: "Get breakpoint definitions" description: "" operationId: "getBreakpointDefinitions" produces: - "application/json" parameters: - name: "inflightTestModelId" in: "path" required: true type: "string" responses: 200: description: "Indicates the breakpoint definitions are found and returned." schema: type: "array" items: $ref: "#/definitions/BreakpointDefinitionDTO" 403: description: "Indicates the user does not have the rights to get the breakpoint\ \ definitions." 404: description: "Indicates the requested inflight test model was not found." security: - basicAuth: [] post: tags: - "Inspect" summary: "Create a new breakpoint definition" description: "" operationId: "createBreakpointDefinition" produces: - "application/json" parameters: - name: "inflightTestModelId" in: "path" required: true type: "string" - in: "body" name: "body" required: false schema: $ref: "#/definitions/CreateBreakpointDefinitionDTO" responses: 200: description: "Indicates the breakpoint definitions is created and returned." schema: $ref: "#/definitions/BreakpointDefinitionDTO" 403: description: "Indicates the user does not have the rights to create a breakpoint\ \ definition." 404: description: "Indicates the requested inflight test model was not found." 409: description: "Indicates there was already a breakpoint created for the same\ \ activity." security: - basicAuth: [] /inflight-test-models/{inflightTestModelId}/breakpoint-definitions/{activityId}: delete: tags: - "Inspect" summary: "Delete a breakpoint definition" description: "" operationId: "deleteBreakpointDefinition" produces: - "application/json" parameters: - name: "inflightTestModelId" in: "path" required: true type: "string" - name: "activityId" in: "path" required: true type: "string" - name: "scopeDefinitionId" in: "query" required: true type: "string" - name: "scopeType" in: "query" required: true type: "string" - name: "actionId" in: "query" required: true type: "string" responses: 200: description: "Indicates the breakpoint definitions is deleted." 403: description: "Indicates the user does not have the rights to delete the\ \ breakpoint definition." 404: description: "Indicates the requested inflight test model was not found." security: - basicAuth: [] /inflight-test-models/{inflightTestModelId}/breakpoint-instances: get: tags: - "Inspect" summary: "Get breakpoint instances" description: "" operationId: "getBreakpointInstances" produces: - "application/json" parameters: - name: "inflightTestModelId" in: "path" required: true type: "string" responses: 200: description: "Indicates the breakpoint instances are found and returned." schema: type: "array" items: $ref: "#/definitions/BreakpointInstanceDTO" 403: description: "Indicates the user does not have the rights to retrieve the\ \ breakpoint instances." 404: description: "Indicates the requested inflight test model was not found." security: - basicAuth: [] /inflight-test-models/{inflightTestModelId}/breakpoint-instances/{breakpointInstanceId}: post: tags: - "Inspect" summary: "Continue an existing breakpoint" description: "" operationId: "continueBreakpoint" produces: - "application/json" parameters: - name: "inflightTestModelId" in: "path" required: true type: "string" - name: "breakpointInstanceId" in: "path" required: true type: "string" - in: "body" name: "body" required: false schema: $ref: "#/definitions/ContinueBreakpointInstanceDTO" responses: 200: description: "Indicates the breakpoint was continued" 403: description: "Indicates the user does not have the rights to continue the\ \ breakpoint." 404: description: "Indicates the requested inflight test model was not found." security: - basicAuth: [] /inflight-test-models/{inflightTestModelId}/execute: post: tags: - "Inspect" summary: "Execute a test model" description: "" operationId: "executeTestModel" produces: - "application/json" parameters: - name: "inflightTestModelId" in: "path" description: "id of the test model" required: true type: "string" - name: "testSetKey" in: "query" description: "When provided, execute only the test set with this key" required: false type: "string" - name: "testDefinitionKey" in: "query" description: "When provided, execute only the test definition with this key\ \ (within the matching test set if testSetKey is also provided)" required: false type: "string" responses: 200: description: "successful operation" schema: $ref: "#/definitions/TestRunInfoDTO" security: - basicAuth: [] /inflight-test-models/{inflightTestModelId}/json: get: tags: - "Inspect" summary: "Get inflight test model json" description: "" operationId: "getTestModelJson" produces: - "application/json" parameters: - name: "inflightTestModelId" in: "path" description: "id of the test model" required: true type: "string" responses: 200: description: "" security: - basicAuth: [] /inflight-test-models/{inflightTestModelId}/last-run: get: tags: - "Inspect" summary: "Get the last persisted run for an inflight test model" description: "" operationId: "getLastRun" produces: - "application/json" parameters: - name: "inflightTestModelId" in: "path" description: "id of the test model" required: true type: "string" responses: 200: description: "successful operation" schema: $ref: "#/definitions/TestRunInfoDTO" security: - basicAuth: [] /inflight-test-models/{inflightTestModelId}/runs: get: tags: - "Inspect" summary: "Get the runs for an inflight test model" description: "" operationId: "getRuns" produces: - "application/json" parameters: - name: "inflightTestModelId" in: "path" description: "id of the test model" required: true type: "string" - name: "order" in: "query" description: "From the paginate request. The sort order, either 'asc' or\ \ 'desc'. Defaults to 'asc'." required: false type: "string" - name: "size" in: "query" description: "From the paginate request. Number of rows to fetch, starting\ \ from start. Defaults to 10." required: false type: "integer" format: "int32" - name: "sort" in: "query" description: "Property to sort the results on" required: false type: "string" - name: "start" in: "query" description: "From the paginate request. Index of the first row to fetch.\ \ Defaults to 0." required: false type: "integer" format: "int32" responses: 200: description: "successful operation" schema: $ref: "#/definitions/DataResponseTestInstanceDTO" security: - basicAuth: [] /inflight-test-models/{testModelId}/skip-definitions: post: tags: - "Inspect" summary: "Create a new skip definition" description: "" operationId: "createSkipDefinition" produces: - "application/json" parameters: - name: "testModelId" in: "path" required: true type: "string" - in: "body" name: "body" required: false schema: $ref: "#/definitions/CreateSkipDefinitionDTO" responses: 200: description: "Indicates the skip definition is created and returned." schema: $ref: "#/definitions/SkipItemDefinitionDTO" 403: description: "Indicates the user does not have the rights to create a breakpoint\ \ definition." 404: description: "Indicates the requested test model was not found." 409: description: "Indicates there was already a skip definition created for\ \ the same activity." security: - basicAuth: [] /inflight-test-models/{testModelId}/skip-definitions/{activityId}: delete: tags: - "Inspect" summary: "Delete a skip definition" description: "" operationId: "deleteSkipDefinition" produces: - "application/json" parameters: - name: "testModelId" in: "path" required: true type: "string" - name: "activityId" in: "path" required: true type: "string" - name: "scopeDefinitionId" in: "query" required: true type: "string" - name: "scopeType" in: "query" required: true type: "string" - name: "actionId" in: "query" required: true type: "string" responses: 200: description: "Indicates the skip definition is deleted." 403: description: "Indicates the user does not have the rights to delete the\ \ skip definition." 404: description: "Indicates the requested test model was not found." security: - basicAuth: [] /inspect-deployments: post: tags: - "Inspect" summary: "Deploy one or more inflight test models bundled inside a ZIP" description: "" operationId: "deployInspectTestModels" produces: - "application/json" parameters: - name: "file" in: "query" description: "ZIP archive with one or more *.test entries" required: true type: "ref" - name: "deploymentKey" in: "query" description: "Stable key identifying the logical deployment. Repeat trigger\ \ under the same key (with replace=true) atomically swaps the contents." required: false type: "string" - name: "name" in: "query" description: "Human-readable deployment name. Falls back to the file name\ \ when omitted." required: false type: "string" responses: 200: description: "successful operation" schema: $ref: "#/definitions/InspectDeploymentSummaryDTO" 201: description: "" security: - basicAuth: [] /inspect/mock-settings: get: tags: - "Inspect" operationId: "getSettings" parameters: [] responses: 200: description: "successful operation" schema: $ref: "#/definitions/MockSettingsDataDTO" security: - basicAuth: [] /inspect/mock-settings/global-default: put: tags: - "Inspect" operationId: "setGlobalDefault" parameters: - in: "body" name: "body" required: false schema: type: "object" additionalProperties: type: "boolean" responses: default: description: "successful operation" security: - basicAuth: [] delete: tags: - "Inspect" operationId: "removeGlobalDefault" parameters: [] responses: default: description: "successful operation" security: - basicAuth: [] /inspect/mock-settings/services: get: tags: - "Inspect" operationId: "searchServices" parameters: - name: "query" in: "query" required: true type: "string" responses: 200: description: "successful operation" schema: type: "array" items: $ref: "#/definitions/MockSearchServiceInfoDTO" security: - basicAuth: [] /inspect/mock-settings/services/{serviceKey}: put: tags: - "Inspect" operationId: "setServiceOverride" parameters: - name: "serviceKey" in: "path" required: true type: "string" - in: "body" name: "body" required: false schema: type: "object" additionalProperties: type: "boolean" responses: default: description: "successful operation" security: - basicAuth: [] delete: tags: - "Inspect" operationId: "removeServiceOverride" parameters: - name: "serviceKey" in: "path" required: true type: "string" responses: default: description: "successful operation" security: - basicAuth: [] /latest-inflight-test-model: get: tags: - "Inspect" summary: "Get latest inflight test model for user" description: "" operationId: "getLatestInflightTestModel" produces: - "application/json" parameters: - name: "scopeId" in: "query" description: "Scope id for the inflight test model" required: true type: "string" - name: "scopeType" in: "query" description: "Scope type for the inflight test model" required: false type: "string" responses: 200: description: "successful operation" schema: $ref: "#/definitions/TestModelDTO" security: - basicAuth: [] /message-events: get: tags: - "Inspect" summary: "Get message events" description: "" operationId: "getSignalEvents" produces: - "application/json" parameters: - name: "scopeId" in: "query" description: "Unique identifier of a scope" required: true type: "string" - name: "scopeType" in: "query" description: "Type of the scope" required: true type: "string" responses: 200: description: "Indicates the message events are found and returned." schema: type: "array" items: $ref: "#/definitions/EventSubscriptionDTO" security: - basicAuth: [] /message-events/{id}: post: tags: - "Inspect" summary: "Trigger message event" description: "" operationId: "triggerMessageEvent" produces: - "application/json" parameters: - name: "messageEventId" in: "path" description: "Unique identifier of the message event" required: true type: "string" - in: "body" name: "body" required: false schema: $ref: "#/definitions/TriggerMessageRequest" responses: 200: description: "Indicates the message event is found and triggered." schema: $ref: "#/definitions/TriggerResultDTO" 404: description: "Indicates the message event was not found." security: - basicAuth: [] /plan-item-instances: get: tags: - "Inspect" summary: "Get plan item instances" description: "" operationId: "getPlanItemInstances" produces: - "application/json" parameters: - name: "scopeId" in: "query" description: "Unique identifier of a scope" required: true type: "string" responses: 200: description: "Indicates the plan item instances are found and returned." schema: type: "array" items: $ref: "#/definitions/PlanItemInstanceDTO" security: - basicAuth: [] /process-instances/{id}: get: tags: - "Inspect" summary: "Get process instance information" description: "" operationId: "getProcessInstanceInfo" produces: - "application/json" parameters: - name: "processInstanceId" in: "path" description: "Unique identifier of the process instance" required: true type: "string" - name: "detailed" in: "query" required: false type: "boolean" responses: 200: description: "Indicates the process instance information was found and returned." schema: $ref: "#/definitions/ProcessInstanceInfoDTO" 403: description: "Indicates the user does not have the rights to query for the\ \ process instance." 404: description: "Indicates the requested process instance was not found." security: - basicAuth: [] /process-instances/{id}/migrate: post: tags: - "Inspect" summary: "Migrate process instance" description: "" operationId: "migrateProcessInstance" parameters: - name: "processInstanceId" in: "path" description: "Unique identifier of the process instance" required: true type: "string" responses: 204: description: "" security: - basicAuth: [] /scoped-decision-execution/{scopeId}/{scopeType}/model: get: tags: - "Inspect" summary: "Get decision execution model" description: "" operationId: "getDecisionExecutionModel" produces: - "application/json" parameters: - name: "scopeId" in: "path" description: "Scope identifier of an instance" required: true type: "string" - name: "scopeType" in: "path" description: "Scope type of an instance" required: true type: "string" - name: "activityId" in: "query" description: "Decision execution activity id" required: true type: "string" responses: 200: description: "successful operation" schema: $ref: "#/definitions/DmnDefinition" security: - basicAuth: [] /scoped-diagram-info/{scopeId}/{scopeType}: get: tags: - "Inspect" summary: "Get scoped diagram info information" description: "" operationId: "getScopedDiagramInfo" produces: - "application/json" parameters: - name: "scopeId" in: "path" description: "Scope identifier of an instance" required: true type: "string" - name: "scopeType" in: "path" description: "Scope type of an instance" required: true type: "string" - name: "subScopeId" in: "query" description: "Sub scope identifier of an instance" required: false type: "string" - name: "modelType" in: "query" description: "Defines the model type of the source model if necessary" required: false type: "string" - name: "testModelId" in: "query" description: "The optional test model id reference" required: false type: "string" responses: 200: description: "Indicates the scoped instance was found and diagram info is\ \ returned." schema: $ref: "#/definitions/JsonNode" 403: description: "Indicates the user does not have the rights to query for the\ \ diagram info." 404: description: "Indicates the requested scoped instance was not found." security: - basicAuth: [] /scoped-form-definition/{scopeId}/{scopeType}: get: tags: - "Inspect" summary: "Get scoped form definition" description: "" operationId: "getScopedFormDefinition" produces: - "application/json" parameters: - name: "scopeId" in: "path" description: "Scope identifier of an instance" required: true type: "string" - name: "scopeType" in: "path" description: "Scope type of an instance" required: true type: "string" - name: "subScopeId" in: "query" description: "Sub scope identifier of an instance" required: false type: "string" - name: "formType" in: "query" description: "Form type of the form definition to be returned" required: false type: "string" responses: 200: description: "Indicates the scoped instance was found and form definition\ \ is returned." schema: $ref: "#/definitions/FormModelRepresentation" 403: description: "Indicates the user does not have the rights to query for the\ \ form definition." 404: description: "Indicates the requested scoped instance was not found." security: - basicAuth: [] /scoped-form-payload/{scopeId}/{scopeType}: get: tags: - "Inspect" summary: "Get scoped form payload" description: "" operationId: "getScopedFormPayload" produces: - "application/json" parameters: - name: "scopeId" in: "path" description: "Scope identifier of an instance" required: true type: "string" - name: "scopeType" in: "path" description: "Scope type of an instance" required: true type: "string" - name: "subScopeId" in: "query" description: "Sub scope identifier of an instance" required: false type: "string" - name: "formType" in: "query" description: "Form type of the form definition to be returned" required: false type: "string" responses: 200: description: "Indicates the scoped instance was found and form payload is\ \ returned." schema: type: "object" additionalProperties: type: "object" 403: description: "Indicates the user does not have the rights to query for the\ \ form payload." 404: description: "Indicates the requested scoped instance was not found." security: - basicAuth: [] /scoped-identity-links/{scopeId}/{scopeType}: get: tags: - "Inspect" summary: "Get scoped identity links" description: "" operationId: "getScopedIdentityLinks" produces: - "application/json" parameters: - name: "scopeId" in: "path" description: "Scope identifier of an instance" required: true type: "string" - name: "scopeType" in: "path" description: "Scope type of an instance" required: true type: "string" responses: 200: description: "Indicates the scoped instance was found and its identity links\ \ are returned." schema: type: "array" items: $ref: "#/definitions/IdentityLinkDTO" 404: description: "Indicates the requested scoped instance was not found." security: - basicAuth: [] post: tags: - "Inspect" summary: "Create a scoped identity link" description: "" operationId: "createScopedIdentityLink" consumes: - "application/json" produces: - "application/json" parameters: - name: "scopeId" in: "path" description: "Scope identifier of an instance" required: true type: "string" - name: "scopeType" in: "path" description: "Scope type of an instance" required: true type: "string" - in: "body" name: "body" required: false schema: $ref: "#/definitions/IdentityLinkCreateDTO" responses: 200: description: "Indicates the identity link was created and the updated list\ \ is returned." schema: type: "array" items: $ref: "#/definitions/IdentityLinkDTO" 400: description: "Indicates invalid input." security: - basicAuth: [] delete: tags: - "Inspect" summary: "Delete a scoped identity link" description: "" operationId: "deleteScopedIdentityLink" produces: - "application/json" parameters: - name: "scopeId" in: "path" description: "Scope identifier of an instance" required: true type: "string" - name: "scopeType" in: "path" description: "Scope type of an instance" required: true type: "string" - name: "userId" in: "query" required: false type: "string" - name: "groupId" in: "query" required: false type: "string" - name: "identityLinkType" in: "query" required: true type: "string" responses: 200: description: "Indicates the identity link was deleted and the updated list\ \ is returned." schema: type: "array" items: $ref: "#/definitions/IdentityLinkDTO" 400: description: "Indicates invalid input." security: - basicAuth: [] /scoped-model-diagram-info/{scopeDefinitionId}/{scopeType}: get: tags: - "Inspect" summary: "Get scoped model diagram info information" description: "" operationId: "getScopedModelDiagramInfo" produces: - "application/json" parameters: - name: "scopeDefinitionId" in: "path" description: "Scope identifier of an instance" required: true type: "string" - name: "scopeType" in: "path" description: "Scope type of an instance" required: true type: "string" responses: 200: description: "Indicates the scoped instance was found and diagram info is\ \ returned." schema: $ref: "#/definitions/JsonNode" 403: description: "Indicates the user does not have the rights to query for the\ \ diagram info." 404: description: "Indicates the requested scoped instance was not found." security: - basicAuth: [] /scoped-variables/{scopeId}/{scopeType}: get: tags: - "Inspect" summary: "Get scoped variables" description: "" operationId: "getScopedVariables" produces: - "application/json" parameters: - name: "scopeId" in: "path" description: "Scope identifier of an instance" required: true type: "string" - name: "scopeType" in: "path" description: "Scope type of an instance" required: true type: "string" - name: "subScopeId" in: "query" description: "Sub scope identifier of an instance" required: false type: "string" responses: 200: description: "Indicates the scoped instance was found and form payload is\ \ returned." schema: type: "array" items: $ref: "#/definitions/VariableDTO" 404: description: "Indicates the requested scoped instance was not found." security: - basicAuth: [] /signal-events: get: tags: - "Inspect" summary: "Get signal events" description: "" operationId: "getSignalEvents" produces: - "application/json" parameters: - name: "scopeId" in: "query" description: "Unique identifier of a scope" required: true type: "string" - name: "scopeType" in: "query" description: "Type of the scope" required: true type: "string" responses: 200: description: "Indicates the signal events are found and returned." schema: type: "array" items: $ref: "#/definitions/EventSubscriptionDTO" security: - basicAuth: [] /signal-events/{id}: post: tags: - "Inspect" summary: "Trigger signal event" description: "" operationId: "triggerSignalEvent" produces: - "application/json" parameters: - name: "signalEventId" in: "path" description: "Unique identifier of the signal event" required: true type: "string" - in: "body" name: "body" required: false schema: $ref: "#/definitions/TriggerSignalRequest" responses: 200: description: "Indicates the signal event is found and triggered." schema: $ref: "#/definitions/TriggerResultDTO" 204: description: "Indicates the signal event was not found." security: - basicAuth: [] /tasks/{id}: get: tags: - "Inspect" summary: "Get task information" description: "" operationId: "getCaseInstanceInfo" produces: - "application/json" parameters: - name: "taskId" in: "path" description: "Unique identifier of the task" required: true type: "string" responses: 200: description: "Indicates the tasks information was found and returned." schema: $ref: "#/definitions/TaskInfoDTO" 403: description: "Indicates the user does not have the rights to query for the\ \ task." 404: description: "Indicates the requested task was not found." security: - basicAuth: [] /test-instances: get: tags: - "Inspect" summary: "Get test instance" description: "" operationId: "getTestInstances" produces: - "application/json" parameters: - name: "testModelId" in: "query" description: "test model id" required: false type: "string" - name: "scopeDefinitionKey" in: "query" description: "scope definition key" required: false type: "string" - name: "scopeType" in: "query" description: "scope type" required: false type: "string" responses: 200: description: "successful operation" schema: type: "array" items: $ref: "#/definitions/TestInstanceDTO" security: - basicAuth: [] /test-instances/{testInstanceId}: get: tags: - "Inspect" summary: "Get test instance model" description: "" operationId: "getTestInstance" produces: - "application/json" parameters: - name: "testInstanceId" in: "path" description: "id of the test instance" required: true type: "string" responses: 200: description: "successful operation" schema: $ref: "#/definitions/TestRunInfoDTO" security: - basicAuth: [] delete: tags: - "Inspect" summary: "Delete test instance" description: "" operationId: "deleteTestInstance" produces: - "application/json" parameters: - name: "testInstanceId" in: "path" description: "id of the test instance" required: true type: "string" responses: 204: description: "" security: - basicAuth: [] /test-user-definitions: get: tags: - "Inspect" summary: "Get test user definitions" description: "" operationId: "getTestUserDefinitions" produces: - "application/json" parameters: - in: "body" name: "request" description: "User request" required: false schema: $ref: "#/definitions/SearchUserRequestDTO" responses: 200: description: "successful operation" schema: type: "array" items: $ref: "#/definitions/TestUserDTO" security: - basicAuth: [] post: tags: - "Inspect" summary: "Create a new test user definition" description: "" operationId: "createTestUserDefinition" produces: - "application/json" parameters: - in: "body" name: "body" required: false schema: $ref: "#/definitions/SaveTestUserDTO" responses: 200: description: "successful operation" schema: $ref: "#/definitions/TestUserDTO" security: - basicAuth: [] /test-user-definitions/{testUserDefinitionId}: get: tags: - "Inspect" summary: "Get test user definition" description: "" operationId: "getTestUserDefinition" produces: - "application/json" parameters: - name: "testUserDefinitionId" in: "path" required: true type: "string" responses: 200: description: "successful operation" schema: $ref: "#/definitions/TestUserDTO" security: - basicAuth: [] put: tags: - "Inspect" summary: "Update test user definition" description: "" operationId: "updateTestUserDefinition" produces: - "application/json" parameters: - name: "testUserDefinitionId" in: "path" required: true type: "string" - in: "body" name: "body" required: false schema: $ref: "#/definitions/SaveTestUserDTO" responses: 200: description: "successful operation" schema: $ref: "#/definitions/TestUserDTO" security: - basicAuth: [] delete: tags: - "Inspect" summary: "Delete a test user definition" description: "" operationId: "deleteTestUserDefinition" parameters: - name: "testUserDefinitionId" in: "path" required: true type: "string" responses: 200: description: "Indicates the breakpoint definitions is deleted." 403: description: "Indicates the user does not have the rights to delete the\ \ breakpoint definition." 404: description: "Indicates the requested inflight test model was not found." security: - basicAuth: [] /timer-jobs: get: tags: - "Inspect" summary: "Get timer jobs" description: "" operationId: "getTimerJobs" produces: - "application/json" parameters: - name: "scopeId" in: "query" description: "Unique identifier of a scope" required: true type: "string" - name: "scopeType" in: "query" description: "Type of the scope" required: true type: "string" responses: 200: description: "Indicates the timer jobs are found and returned." schema: type: "array" items: $ref: "#/definitions/TimerJobDTO" security: - basicAuth: [] /timer-jobs/{id}: post: tags: - "Inspect" summary: "Trigger timer job" description: "" operationId: "triggerTimerJob" produces: - "application/json" parameters: - name: "timerJobId" in: "path" description: "Unique identifier of the timer job" required: true type: "string" - in: "body" name: "body" required: false schema: $ref: "#/definitions/TriggerTimerRequest" responses: 200: description: "Indicates the timer job is found and triggered." schema: $ref: "#/definitions/TriggerResultDTO" security: - basicAuth: [] /user-definitions: get: tags: - "User Definitions" summary: "List user definitions" description: "" operationId: "getUserDefinitions" produces: - "application/json" parameters: [] responses: 200: description: "successful operation" schema: type: "array" items: $ref: "#/definitions/UserDefinitionResponse" security: - basicAuth: [] /users: get: tags: - "Inspect" summary: "Get users" description: "" operationId: "getUsers" produces: - "application/json" parameters: - in: "body" name: "request" description: "User request" required: false schema: $ref: "#/definitions/SearchUserRequestDTO" responses: 200: description: "successful operation" schema: type: "array" items: $ref: "#/definitions/UserDTO" security: - basicAuth: [] /work-definitions: get: tags: - "Inspect" - "Definitions" summary: "Get work definitions" description: "" operationId: "listWorkDefinitions" produces: - "application/json" parameters: - name: "order" in: "query" description: "From the paginate request. The sort order, either 'asc' or\ \ 'desc'. Defaults to 'asc'." required: false type: "string" - name: "size" in: "query" description: "From the paginate request. Number of rows to fetch, starting\ \ from start. Defaults to 10." required: false type: "integer" format: "int32" - name: "sort" in: "query" description: "Property to sort the results on" required: false type: "string" - name: "start" in: "query" description: "From the paginate request. Index of the first row to fetch.\ \ Defaults to 0." required: false type: "integer" format: "int32" - name: "type" in: "query" description: "" required: false type: "string" responses: 200: description: "Indicates the definitions were found and returned." schema: $ref: "#/definitions/DataResponseWorkDefinitionRepresentation" security: - basicAuth: [] /work-definitions/{id}: get: tags: - "Inspect" - "Definitions" summary: "Get work definition information" description: "" operationId: "getWorkDefinitionInfo" produces: - "application/json" parameters: - name: "processInstanceId" in: "path" description: "Unique identifier of the process instance" required: true type: "string" - name: "detailed" in: "query" required: false type: "boolean" responses: 200: description: "Indicates the work definition information was found and returned." schema: $ref: "#/definitions/WorkDefinitionInfoDTO" 403: description: "Indicates the user does not have the rights to query for the\ \ work definition." 404: description: "Indicates the requested work definition was not found." security: - basicAuth: [] securityDefinitions: basicAuth: type: "basic" definitions: ActivityInfoDTO: type: "object" properties: id: type: "string" scopeId: type: "string" subScopeId: type: "string" scopeDefinitionId: type: "string" scopeDefinitionKey: type: "string" scopeType: type: "string" activityId: type: "string" activityName: type: "string" activityType: type: "string" childScopeId: type: "string" childScopeType: type: "string" taskId: type: "string" transactionOrder: type: "integer" format: "int32" userId: type: "string" active: type: "boolean" enabled: type: "boolean" available: type: "boolean" completed: type: "boolean" breakpointId: type: "string" breakpointType: type: "string" hasErrors: type: "boolean" ActivityInstanceDTO: type: "object" properties: id: type: "string" activityId: type: "string" activityName: type: "string" activityType: type: "string" startTime: type: "string" format: "date-time" endTime: type: "string" format: "date-time" AgentInstanceDTO: type: "object" properties: id: type: "string" startTime: type: "string" format: "date-time" agentDefinitionId: type: "string" agentDefinitionKey: type: "string" agentDefinitionName: type: "string" referenceId: type: "string" referenceType: type: "string" callbackId: type: "string" callbackType: type: "string" callbackScopeId: type: "string" chatEnabled: type: "boolean" startUserId: type: "string" tenantId: type: "string" AgentInvocationDTO: type: "object" properties: id: type: "string" agentInstanceId: type: "string" agentDefinitionId: type: "string" agentDefinitionKey: type: "string" operationKey: type: "string" startTime: type: "string" format: "date-time" endTime: type: "string" format: "date-time" promptTokenCount: type: "integer" format: "int64" outputTokenCount: type: "integer" format: "int64" AgentInvocationExchangeDTO: type: "object" properties: id: type: "string" agentInstanceId: type: "string" invocationId: type: "string" agentDefinitionId: type: "string" agentDefinitionKey: type: "string" creationTime: type: "string" format: "date-time" endTime: type: "string" format: "date-time" duration: type: "integer" format: "int64" type: type: "string" subType: type: "string" userId: type: "string" promptTokenCount: type: "integer" format: "int64" outputTokenCount: type: "integer" format: "int64" transactionOrder: type: "integer" format: "int32" AgentInvocationExchangePartDTO: type: "object" properties: id: type: "string" exchangeId: type: "string" type: type: "string" subType: type: "string" content: type: "string" invocationSequence: type: "integer" format: "int64" AssertionResultDTO: type: "object" properties: name: type: "string" operator: type: "string" expectedValue: type: "object" actualValue: type: "object" passed: type: "boolean" missingField: type: "boolean" actualFallback: type: "object" AuthorityRequirement: type: "object" properties: id: type: "string" label: type: "string" description: type: "string" extensionElements: type: "object" additionalProperties: type: "array" items: $ref: "#/definitions/DmnExtensionElement" attributes: type: "object" additionalProperties: type: "array" items: $ref: "#/definitions/DmnExtensionAttribute" name: type: "string" requiredDecision: $ref: "#/definitions/DmnElementReference" requiredInput: $ref: "#/definitions/DmnElementReference" requiredAuthority: $ref: "#/definitions/DmnElementReference" BreakpointDefinitionDTO: type: "object" properties: scopeDefinitionId: type: "string" scopeType: type: "string" activityId: type: "string" type: type: "string" enum: - "INSTANCE_INIT" - "BEFORE" - "AFTER" dynamic: type: "boolean" BreakpointInstanceDTO: type: "object" properties: id: type: "string" scopeId: type: "string" subScopeId: type: "string" scopeType: type: "string" activityId: type: "string" type: type: "string" enum: - "INSTANCE_INIT" - "BEFORE" - "AFTER" BulkTestAppDTO: type: "object" properties: appKey: type: "string" appName: type: "string" BulkTestRunRequest: type: "object" properties: appKey: type: "string" scopeType: type: "string" testSetNameInclude: type: "array" items: type: "string" testSetNameExclude: type: "array" items: type: "string" testEntries: type: "array" items: $ref: "#/definitions/TestRunEntry" CaseInstanceInfoDTO: type: "object" properties: id: type: "string" name: type: "string" description: type: "string" tenantId: type: "string" startTime: type: "string" format: "date-time" startUserId: type: "string" startUserName: type: "string" definitionId: type: "string" definitionName: type: "string" definitionKey: type: "string" definitionVersion: type: "integer" format: "int32" latestDefinition: type: "boolean" exceptionInfo: $ref: "#/definitions/ExceptionInfoDTO" restExecutionInfo: $ref: "#/definitions/RestExecutionInfoDTO" applicationName: type: "string" ChannelDefinitionResponse: type: "object" properties: id: type: "string" example: "oneChannel:1:4" url: type: "string" example: "http://localhost:8182/event-registry-repository/channel-definitions/oneChannel%3A1%3A4" key: type: "string" example: "oneChannel" version: type: "integer" format: "int32" example: 1 name: type: "string" example: "The One Channel" type: type: "string" example: "inbound" enum: - "inbound" - "outbound" implementation: type: "string" example: "kafka" createTime: type: "string" format: "date-time" example: "2010-10-13T14:54:26.750+02:00" description: type: "string" example: "This is a channel definition for testing purposes" tenantId: type: "string" example: "null" deploymentId: type: "string" example: "2" deploymentUrl: type: "string" example: "http://localhost:8182/event-registry-repository/deployments/2" resourceName: type: "string" example: "oneChannel.channel" resource: type: "string" example: "http://localhost:8182/event-registry-repository/deployments/2/resources/oneChannel.channel" description: "Contains the actual deployed channel definition JSON." category: type: "string" example: "Examples" ChannelModel: type: "object" properties: key: type: "string" category: type: "string" name: type: "string" description: type: "string" channelType: type: "string" type: type: "string" extension: $ref: "#/definitions/JsonNode" ContinueBreakpointInstanceDTO: type: "object" properties: continuationType: type: "string" CreateBreakpointDefinitionDTO: type: "object" properties: activityId: type: "string" scopeDefinitionId: type: "string" scopeDefinitionKey: type: "string" scopeType: type: "string" actionId: type: "string" CreateSkipDefinitionDTO: type: "object" properties: activityId: type: "string" scopeDefinitionId: type: "string" scopeDefinitionKey: type: "string" scopeType: type: "string" actionId: type: "string" CurrentInstanceDTO: type: "object" properties: id: type: "string" name: type: "string" scopeId: type: "string" scopeType: type: "string" scopeName: type: "string" scopeDefinitionId: type: "string" scopeDefinitionKey: type: "string" scopeDefinitionName: type: "string" parentScopeId: type: "string" parentScopeType: type: "string" tenantId: type: "string" hasScopeInstance: type: "boolean" creationTime: type: "string" format: "date-time" creatorId: type: "string" creatorUserName: type: "string" endTime: type: "string" format: "date-time" steps: type: "array" items: $ref: "#/definitions/ActivityInfoDTO" securityScopes: type: "object" additionalProperties: $ref: "#/definitions/SecurityScopeDTO" actionCounter: type: "integer" format: "int32" CustomValidationDefinition: type: "object" properties: expression: type: "string" errorMsg: type: "string" i18n: type: "object" additionalProperties: type: "object" additionalProperties: 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" DataResponseBulkTestAppDTO: type: "object" properties: data: type: "array" items: $ref: "#/definitions/BulkTestAppDTO" total: type: "integer" format: "int64" start: type: "integer" format: "int32" sort: type: "string" order: type: "string" size: type: "integer" format: "int32" DataResponseChannelDefinitionResponse: type: "object" properties: data: type: "array" items: $ref: "#/definitions/ChannelDefinitionResponse" total: type: "integer" format: "int64" start: type: "integer" format: "int32" sort: type: "string" order: type: "string" size: type: "integer" format: "int32" DataResponseEventDefinitionResponse: type: "object" properties: data: type: "array" items: $ref: "#/definitions/EventDefinitionResponse" total: type: "integer" format: "int64" start: type: "integer" format: "int32" sort: type: "string" order: type: "string" size: type: "integer" format: "int32" DataResponseTestInstanceDTO: type: "object" properties: data: type: "array" items: $ref: "#/definitions/TestInstanceDTO" total: type: "integer" format: "int64" start: type: "integer" format: "int32" sort: type: "string" order: type: "string" size: type: "integer" format: "int32" DataResponseTestRunDTO: type: "object" properties: data: type: "array" items: $ref: "#/definitions/TestRunDTO" total: type: "integer" format: "int64" start: type: "integer" format: "int32" sort: type: "string" order: type: "string" size: type: "integer" format: "int32" DataResponseWorkDefinitionRepresentation: type: "object" properties: data: type: "array" items: $ref: "#/definitions/WorkDefinitionRepresentation" total: type: "integer" format: "int64" start: type: "integer" format: "int32" sort: type: "string" order: type: "string" size: type: "integer" format: "int32" DeadLetterJobDTO: type: "object" properties: id: type: "string" type: type: "string" activityId: type: "string" activityName: type: "string" activityType: type: "string" dueDate: type: "string" format: "date-time" errorMessage: type: "string" Decision: type: "object" properties: id: type: "string" label: type: "string" description: type: "string" extensionElements: type: "object" additionalProperties: type: "array" items: $ref: "#/definitions/DmnExtensionElement" attributes: type: "object" additionalProperties: type: "array" items: $ref: "#/definitions/DmnExtensionAttribute" name: type: "string" question: type: "string" allowedAnswers: type: "string" variable: $ref: "#/definitions/InformationItem" requiredDecisions: type: "array" items: $ref: "#/definitions/InformationRequirement" requiredInputs: type: "array" items: $ref: "#/definitions/InformationRequirement" authorityRequirements: type: "array" items: $ref: "#/definitions/AuthorityRequirement" expression: $ref: "#/definitions/Expression" forceDMN11: type: "boolean" DecisionExecutionDTO: type: "object" properties: id: type: "string" url: type: "string" decisionDefinitionId: type: "string" deploymentId: type: "string" activityId: type: "string" executionId: type: "string" instanceId: type: "string" scopeType: type: "string" failed: type: "boolean" startTime: type: "string" format: "date-time" endTime: type: "string" format: "date-time" tenantId: type: "string" decisionKey: type: "string" decisionName: type: "string" decisionVersion: type: "string" DecisionService: type: "object" properties: id: type: "string" label: type: "string" description: type: "string" extensionElements: type: "object" additionalProperties: type: "array" items: $ref: "#/definitions/DmnExtensionElement" attributes: type: "object" additionalProperties: type: "array" items: $ref: "#/definitions/DmnExtensionAttribute" name: type: "string" outputDecisions: type: "array" items: $ref: "#/definitions/DmnElementReference" encapsulatedDecisions: type: "array" items: $ref: "#/definitions/DmnElementReference" inputDecisions: type: "array" items: $ref: "#/definitions/DmnElementReference" inputData: type: "array" items: $ref: "#/definitions/DmnElementReference" DmnDefinition: type: "object" properties: id: type: "string" label: type: "string" description: type: "string" extensionElements: type: "object" additionalProperties: type: "array" items: $ref: "#/definitions/DmnExtensionElement" attributes: type: "object" additionalProperties: type: "array" items: $ref: "#/definitions/DmnExtensionAttribute" name: type: "string" expressionLanguage: type: "string" typeLanguage: type: "string" namespace: type: "string" exporter: type: "string" exporterVersion: type: "string" inputData: type: "array" items: $ref: "#/definitions/InputData" itemDefinitions: type: "array" items: $ref: "#/definitions/ItemDefinition" decisions: type: "array" items: $ref: "#/definitions/Decision" decisionServices: type: "array" items: $ref: "#/definitions/DecisionService" locationMap: type: "object" additionalProperties: $ref: "#/definitions/GraphicInfo" locationByDiagramIdMap: type: "object" additionalProperties: type: "object" additionalProperties: $ref: "#/definitions/GraphicInfo" labelLocationByDiagramIdMap: type: "object" additionalProperties: type: "object" additionalProperties: $ref: "#/definitions/GraphicInfo" flowLocationMap: type: "object" additionalProperties: type: "array" items: $ref: "#/definitions/GraphicInfo" flowLocationByDiagramIdMap: type: "object" additionalProperties: type: "object" additionalProperties: type: "array" items: $ref: "#/definitions/GraphicInfo" decisionServiceDividerLocationMap: type: "object" additionalProperties: type: "array" items: $ref: "#/definitions/GraphicInfo" decisionServiceDividerLocationByDiagramIdMap: type: "object" additionalProperties: type: "object" additionalProperties: type: "array" items: $ref: "#/definitions/GraphicInfo" namespaces: type: "object" additionalProperties: type: "string" diDiagramMap: type: "object" additionalProperties: $ref: "#/definitions/DmnDiDiagram" DmnDiDiagram: type: "object" properties: id: type: "string" label: type: "string" description: type: "string" extensionElements: type: "object" additionalProperties: type: "array" items: $ref: "#/definitions/DmnExtensionElement" attributes: type: "object" additionalProperties: type: "array" items: $ref: "#/definitions/DmnExtensionAttribute" name: type: "string" graphicInfo: $ref: "#/definitions/GraphicInfo" DmnElement: type: "object" properties: id: type: "string" label: type: "string" description: type: "string" extensionElements: type: "object" additionalProperties: type: "array" items: $ref: "#/definitions/DmnExtensionElement" attributes: type: "object" additionalProperties: type: "array" items: $ref: "#/definitions/DmnExtensionAttribute" DmnElementReference: type: "object" properties: href: type: "string" parsedId: type: "string" DmnExtensionAttribute: type: "object" properties: name: type: "string" value: type: "string" namespacePrefix: type: "string" namespace: type: "string" DmnExtensionElement: type: "object" properties: id: type: "string" label: type: "string" description: type: "string" extensionElements: type: "object" additionalProperties: type: "array" items: $ref: "#/definitions/DmnExtensionElement" attributes: type: "object" additionalProperties: type: "array" items: $ref: "#/definitions/DmnExtensionAttribute" name: type: "string" namespacePrefix: type: "string" namespace: type: "string" elementText: type: "string" childElements: type: "object" additionalProperties: type: "array" items: $ref: "#/definitions/DmnExtensionElement" EntityLinkDTO: type: "object" properties: scopeId: type: "string" scopeType: type: "string" scopeName: type: "string" scopeDefinitionId: type: "string" scopeDefinitionKey: type: "string" scopeDefinitionName: type: "string" state: type: "string" navigatable: type: "boolean" children: type: "array" items: $ref: "#/definitions/EntityLinkDTO" EvaluateExpressionDTO: type: "object" properties: expression: type: "string" scopeId: type: "string" subScopeId: type: "string" scopeType: type: "string" EvaluatorResultDTO: type: "object" properties: evaluatorKey: type: "string" score: type: "number" format: "double" passed: type: "boolean" reason: type: "string" scoreMin: type: "number" format: "double" scoreMax: type: "number" format: "double" EventDefinition: type: "object" properties: id: type: "string" eventType: type: "string" implementationType: type: "string" expression: type: "string" resultVariable: type: "string" EventDefinitionResponse: type: "object" properties: id: type: "string" example: "oneEvent:1:4" url: type: "string" example: "http://localhost:8182/event-registry-repository/event-definitions/oneEvent%3A1%3A4" key: type: "string" example: "oneEvent" version: type: "integer" format: "int32" example: 1 name: type: "string" example: "The One Event" description: type: "string" example: "This is an event definition for testing purposes" tenantId: type: "string" example: "null" deploymentId: type: "string" example: "2" deploymentUrl: type: "string" example: "http://localhost:8182/event-registry-repository/deployments/2" resourceName: type: "string" example: "oneEvent.event" resource: type: "string" example: "http://localhost:8182/event-registry-repository/deployments/2/resources/oneEvent.event" description: "Contains the actual deployed event definition JSON." category: type: "string" example: "Examples" EventModel: type: "object" properties: key: type: "string" name: type: "string" payload: type: "array" items: $ref: "#/definitions/EventPayload" EventPayload: type: "object" properties: name: type: "string" type: type: "string" header: type: "boolean" correlationParameter: type: "boolean" metaParameter: type: "boolean" extensionProperties: type: "object" additionalProperties: type: "string" fullPayload: type: "boolean" EventSubscriptionDTO: type: "object" properties: id: type: "string" eventType: type: "string" eventName: type: "string" activityId: type: "string" activityName: type: "string" activityType: type: "string" attachedToActivityId: type: "string" attachedToActivityName: type: "string" created: type: "string" format: "date-time" ExceptionDTO: type: "object" properties: scopeId: type: "string" scopeType: type: "string" timestamp: type: "string" format: "date-time" message: type: "string" stacktrace: type: "string" ExceptionInfoDTO: type: "object" properties: exceptions: type: "array" items: $ref: "#/definitions/ExceptionDTO" ExecuteTestRequest: type: "object" properties: testModel: $ref: "#/definitions/TestModelDTO" testResources: type: "array" items: $ref: "#/definitions/TestResourceEntry" testSetKey: type: "string" tenantId: type: "string" ExecutionDTO: type: "object" properties: id: type: "string" activityId: type: "string" activityName: type: "string" activityType: type: "string" attachedToActivityId: type: "string" attachedToActivityName: type: "string" startTime: type: "string" format: "date-time" Expression: type: "object" properties: id: type: "string" label: type: "string" description: type: "string" extensionElements: type: "object" additionalProperties: type: "array" items: $ref: "#/definitions/DmnExtensionElement" attributes: type: "object" additionalProperties: type: "array" items: $ref: "#/definitions/DmnExtensionAttribute" typeRef: type: "string" ExpressionValueDTO: type: "object" properties: value: type: "object" valueType: type: "string" valid: type: "boolean" exception: type: "string" FormDataModel: type: "object" properties: type: type: "string" dataObjectDefinitionKey: type: "string" mode: type: "string" FormModelRepresentation: type: "object" properties: id: type: "string" name: type: "string" description: type: "string" key: type: "string" version: type: "integer" format: "int32" formKey: type: "string" dialogSize: type: "string" dialogTitle: type: "string" dialogDescription: type: "string" forceValidation: type: "boolean" defaultDateFormat: type: "string" defaultNumberFormat: type: "string" metadata: $ref: "#/definitions/MetadataDefinition" rows: type: "array" items: $ref: "#/definitions/RowDefinition" section: $ref: "#/definitions/SectionDefinition" outcomes: type: "array" items: $ref: "#/definitions/OutcomeDefinition" customValidations: type: "array" items: $ref: "#/definitions/CustomValidationDefinition" dataModel: type: "object" additionalProperties: $ref: "#/definitions/FormDataModel" formModelEvents: type: "array" items: $ref: "#/definitions/EventDefinition" i18n: type: "object" additionalProperties: type: "object" additionalProperties: type: "string" GraphicInfo: type: "object" properties: id: type: "string" label: type: "string" description: type: "string" extensionElements: type: "object" additionalProperties: type: "array" items: $ref: "#/definitions/DmnExtensionElement" attributes: type: "object" additionalProperties: type: "array" items: $ref: "#/definitions/DmnExtensionAttribute" x: type: "number" format: "double" y: type: "number" format: "double" height: type: "number" format: "double" width: type: "number" format: "double" element: $ref: "#/definitions/DmnElement" expanded: type: "boolean" xmlRowNumber: type: "integer" format: "int32" xmlColumnNumber: type: "integer" format: "int32" IdentityLinkCreateDTO: type: "object" properties: userId: type: "string" groupId: type: "string" identityLinkType: type: "string" IdentityLinkDTO: type: "object" properties: userId: type: "string" userName: type: "string" groupId: type: "string" groupName: type: "string" identityLinkType: type: "string" InflightTestRowDTO: type: "object" properties: id: type: "string" name: type: "string" testModelId: type: "string" testModelName: type: "string" scopeDefinitionId: type: "string" scopeDefinitionKey: type: "string" scopeDefinitionName: type: "string" scopeType: type: "string" scopeId: type: "string" creationTime: type: "string" format: "date-time" creatorId: type: "string" creatorUserName: type: "string" endTime: type: "string" format: "date-time" hasScopeInstance: type: "boolean" testSetKey: type: "string" testSetName: type: "string" operationKey: type: "string" testDefinitionKey: type: "string" testDefinitionName: type: "string" status: type: "string" durationMs: type: "integer" format: "int64" passedCount: type: "integer" format: "int32" failedCount: type: "integer" format: "int32" totalSteps: type: "integer" format: "int32" progress: type: "number" format: "double" failedStepName: type: "string" lastRunDate: type: "string" format: "date-time" recentRuns: type: "array" items: $ref: "#/definitions/TestInstanceDTO" InformationItem: type: "object" properties: id: type: "string" label: type: "string" description: type: "string" extensionElements: type: "object" additionalProperties: type: "array" items: $ref: "#/definitions/DmnExtensionElement" attributes: type: "object" additionalProperties: type: "array" items: $ref: "#/definitions/DmnExtensionAttribute" name: type: "string" typeRef: type: "string" InformationRequirement: type: "object" properties: id: type: "string" label: type: "string" description: type: "string" extensionElements: type: "object" additionalProperties: type: "array" items: $ref: "#/definitions/DmnExtensionElement" attributes: type: "object" additionalProperties: type: "array" items: $ref: "#/definitions/DmnExtensionAttribute" name: type: "string" requiredDecision: $ref: "#/definitions/DmnElementReference" requiredInput: $ref: "#/definitions/DmnElementReference" InputData: type: "object" properties: id: type: "string" label: type: "string" description: type: "string" extensionElements: type: "object" additionalProperties: type: "array" items: $ref: "#/definitions/DmnExtensionElement" attributes: type: "object" additionalProperties: type: "array" items: $ref: "#/definitions/DmnExtensionAttribute" name: type: "string" variable: $ref: "#/definitions/InformationItem" InspectDeployedTestModelDTO: type: "object" properties: id: type: "string" key: type: "string" name: type: "string" scopeType: type: "string" scopeDefinitionKey: type: "string" testSetKeys: type: "array" items: type: "string" InspectDeploymentSummaryDTO: type: "object" properties: deploymentId: type: "string" name: type: "string" key: type: "string" tenantId: type: "string" testModels: type: "array" items: $ref: "#/definitions/InspectDeployedTestModelDTO" InstanceRoleDTO: type: "object" properties: type: type: "string" userId: type: "string" userName: type: "string" groupKey: type: "string" groupName: type: "string" ItemDefinition: type: "object" properties: id: type: "string" label: type: "string" description: type: "string" extensionElements: type: "object" additionalProperties: type: "array" items: $ref: "#/definitions/DmnExtensionElement" attributes: type: "object" additionalProperties: type: "array" items: $ref: "#/definitions/DmnExtensionAttribute" name: type: "string" typeRef: type: "string" allowedValues: $ref: "#/definitions/UnaryTests" itemComponents: type: "array" items: $ref: "#/definitions/ItemDefinition" typeLanguage: type: "string" collection: type: "boolean" JsonNode: type: "object" properties: string: type: "boolean" valueNode: type: "boolean" missingNode: type: "boolean" short: type: "boolean" double: type: "boolean" bigDecimal: type: "boolean" bigInteger: type: "boolean" textual: type: "boolean" boolean: type: "boolean" container: type: "boolean" object: type: "boolean" binary: type: "boolean" number: type: "boolean" nodeType: type: "string" enum: - "ARRAY" - "BINARY" - "BOOLEAN" - "MISSING" - "NULL" - "NUMBER" - "OBJECT" - "POJO" - "STRING" long: type: "boolean" pojo: type: "boolean" int: type: "boolean" integralNumber: type: "boolean" floatingPointNumber: type: "boolean" array: type: "boolean" empty: type: "boolean" null: type: "boolean" float: type: "boolean" embeddedValue: type: "boolean" MetadataDefinition: type: "object" properties: key: type: "string" name: type: "string" description: type: "string" version: type: "string" modelType: type: "string" flowableDesignVersion: type: "integer" format: "int32" MockSearchServiceInfoDTO: type: "object" properties: key: type: "string" name: type: "string" MockSettingsDataDTO: type: "object" properties: globalDefault: type: "boolean" serviceOverrides: type: "object" additionalProperties: type: "boolean" serviceNames: type: "object" additionalProperties: type: "string" MultiInstanceMetaDTO: type: "object" properties: activityId: type: "string" iterations: type: "integer" format: "int32" type: type: "string" OutcomeDefinition: type: "object" properties: label: type: "string" value: type: "string" visible: type: "string" enabled: type: "string" primary: type: "string" ignorePayload: type: "boolean" ignoreValidation: type: "boolean" hideErrors: type: "boolean" styleClass: type: "string" navigationUrl: type: "string" outcomeFormKey: type: "string" i18n: type: "object" additionalProperties: type: "object" additionalProperties: type: "string" PlanItemInstanceDTO: type: "object" properties: id: type: "string" activityId: type: "string" activityName: type: "string" activityType: type: "string" state: type: "string" createTime: type: "string" format: "date-time" ProcessInstanceInfoDTO: type: "object" properties: id: type: "string" name: type: "string" description: type: "string" tenantId: type: "string" startTime: type: "string" format: "date-time" startUserId: type: "string" startUserName: type: "string" definitionId: type: "string" definitionName: type: "string" definitionKey: type: "string" definitionVersion: type: "integer" format: "int32" latestDefinition: type: "boolean" exceptionInfo: $ref: "#/definitions/ExceptionInfoDTO" restExecutionInfo: $ref: "#/definitions/RestExecutionInfoDTO" applicationName: type: "string" Request: type: "object" properties: url: type: "string" method: type: "string" headers: type: "object" additionalProperties: type: "array" items: type: "string" body: type: "string" Response: type: "object" properties: statusCode: type: "integer" format: "int32" headers: type: "object" additionalProperties: type: "array" items: type: "string" body: type: "string" RestExecutionDTO: type: "object" properties: scopeId: type: "string" scopeType: type: "string" timestamp: type: "string" format: "date-time" request: $ref: "#/definitions/Request" response: $ref: "#/definitions/Response" service: $ref: "#/definitions/Service" mocked: type: "boolean" RestExecutionInfoDTO: type: "object" properties: restExecutions: type: "array" items: $ref: "#/definitions/RestExecutionDTO" RowDefinition: type: "object" properties: cols: type: "array" items: type: "object" additionalProperties: type: "object" SaveTestUserDTO: type: "object" properties: userName: type: "string" firstName: type: "string" lastName: type: "string" displayName: type: "string" userDefinitionKey: type: "string" groupKeys: type: "array" items: type: "string" email: type: "string" language: type: "string" theme: type: "string" tenantId: type: "string" ScopeTestDefinitionDTO: type: "object" properties: name: type: "string" key: type: "string" operationKey: type: "string" inputParameters: type: "object" additionalProperties: type: "object" guardrailInputParameters: type: "object" additionalProperties: type: "object" additionalProperties: type: "object" serviceMockOverrides: type: "array" items: $ref: "#/definitions/ServiceMockOverrideDTO" expectedOutputParameters: $ref: "#/definitions/JsonNode" steps: type: "array" items: $ref: "#/definitions/TestStepDTO" multiInstance: type: "array" items: $ref: "#/definitions/MultiInstanceMetaDTO" skip: type: "boolean" SearchUserRequestDTO: type: "object" properties: id: type: "string" displayName: type: "string" displayNameLike: type: "string" displayNameLikeIgnoreCase: type: "string" SectionDefinition: type: "object" properties: name: type: "string" visibility: type: "string" SecurityScopeDTO: type: "object" properties: userId: type: "string" userDefinitionKey: type: "string" groupKeys: type: "array" items: type: "string" tenantId: type: "string" SendEventRequest: type: "object" properties: createTestDefinition: type: "boolean" description: "Whether a test definition needs to be created for the request.\ \ Only used when triggering for a definition" channelDefinitionKey: type: "string" description: "The optional key for the channel definition on which the event\ \ needs to be sent to" eventDefinitionKey: type: "string" description: "The optional event key that should be used for the event." eventDefinitionPayload: type: "array" description: "The payload for the event definition key." items: $ref: "#/definitions/EventPayload" customPayload: type: "string" description: "The custom payload that needs to be send on the channel." description: "Request that is used for sending an event to a channel" Service: type: "object" properties: key: type: "string" operation: type: "string" ServiceMockOverrideDTO: type: "object" properties: entryType: type: "string" serviceKey: type: "string" operationKey: type: "string" applyTo: type: "string" mode: type: "string" mockResponseKey: type: "string" SkipItemDefinitionDTO: type: "object" properties: scopeDefinitionId: type: "string" scopeDefinitionKey: type: "string" scopeType: type: "string" activityId: type: "string" TaskInfoDTO: type: "object" properties: id: type: "string" name: type: "string" assignee: type: "string" owner: type: "string" dueDate: type: "string" format: "date-time" scopeId: type: "string" scopeType: type: "string" scopeDefinitionId: type: "string" scopeDefinitionKey: type: "string" scopeDefinitionName: type: "string" formKey: type: "string" tenantId: type: "string" TestActionDTO: type: "object" properties: id: type: "string" type: type: "string" name: type: "string" transactionBoundary: type: "string" valueType: type: "string" value: $ref: "#/definitions/JsonNode" contextValues: $ref: "#/definitions/JsonNode" actionCounter: type: "integer" format: "int32" ignoreActionCounter: type: "boolean" editable: type: "boolean" deletable: type: "boolean" TestActionTypeDTO: type: "object" properties: id: type: "string" name: type: "string" transactionBoundary: type: "string" transactionBoundaryEditable: type: "boolean" TestFailureDTO: type: "object" properties: actual: $ref: "#/definitions/JsonNode" expected: $ref: "#/definitions/JsonNode" exceptionMessage: type: "string" TestInstanceDTO: type: "object" properties: id: type: "string" testModelId: type: "string" testSetKey: type: "string" scopeId: type: "string" scopeType: type: "string" scopeDefinitionId: type: "string" scopeDefinitionKey: type: "string" startTime: type: "string" format: "date-time" endTime: type: "string" format: "date-time" durationMs: type: "integer" format: "int64" status: type: "string" result: type: "string" passedCount: type: "integer" format: "int32" failedCount: type: "integer" format: "int32" totalSteps: type: "integer" format: "int32" progress: type: "number" format: "double" failedStepName: type: "string" tenantId: type: "string" TestModelDTO: type: "object" properties: id: type: "string" name: type: "string" scopeId: type: "string" scopeType: type: "string" scopeName: type: "string" scopeDefinitionId: type: "string" scopeDefinitionKey: type: "string" scopeDefinitionName: type: "string" parentScopeId: type: "string" parentScopeType: type: "string" tenantId: type: "string" hasScopeInstance: type: "boolean" creationTime: type: "string" format: "date-time" creatorId: type: "string" creatorUserName: type: "string" endTime: type: "string" format: "date-time" steps: type: "array" items: $ref: "#/definitions/TestStepDTO" testSets: type: "array" items: $ref: "#/definitions/TestSetDTO" securityScopes: type: "object" additionalProperties: $ref: "#/definitions/SecurityScopeDTO" actionCounter: type: "integer" format: "int32" TestResourceEntry: type: "object" properties: name: type: "string" fileName: type: "string" mimeType: type: "string" base64: type: "string" TestResultDTO: type: "object" properties: testSetKey: type: "string" key: type: "string" status: type: "string" failure: $ref: "#/definitions/TestFailureDTO" assertionResults: type: "array" items: $ref: "#/definitions/AssertionResultDTO" evaluatorResults: type: "array" items: $ref: "#/definitions/EvaluatorResultDTO" actualOutput: type: "string" durationMs: type: "integer" format: "int64" promptTokenCount: type: "integer" format: "int64" outputTokenCount: type: "integer" format: "int64" stepResults: type: "array" items: $ref: "#/definitions/TestStepResultDTO" scopeId: type: "string" scopeType: type: "string" TestRunDTO: type: "object" properties: id: type: "string" status: type: "string" startTime: type: "string" format: "date-time" endTime: type: "string" format: "date-time" creatorId: type: "string" tenantId: type: "string" totalCount: type: "integer" format: "int32" completedCount: type: "integer" format: "int32" passedCount: type: "integer" format: "int32" failedCount: type: "integer" format: "int32" filterContent: type: "string" skippedModelIds: type: "array" items: type: "string" TestRunEntry: type: "object" properties: testModelId: type: "string" testSetKey: type: "string" testDefinitionKeys: type: "array" items: type: "string" TestRunInfoDTO: type: "object" properties: testName: type: "string" scopeId: type: "string" scopeType: type: "string" scopeDefinitionId: type: "string" scopeDefinitionKey: type: "string" scopeDefinitionName: type: "string" tenantId: type: "string" testRunMessages: type: "array" items: $ref: "#/definitions/TestRunLogEntryDTO" testModel: $ref: "#/definitions/TestModelDTO" hasErrors: type: "boolean" testInstanceId: type: "string" testResults: type: "array" items: $ref: "#/definitions/TestResultDTO" skippedCount: type: "integer" format: "int32" setCount: type: "integer" format: "int32" definitionCount: type: "integer" format: "int32" passedDefinitionCount: type: "integer" format: "int32" TestRunLogEntryDTO: type: "object" properties: message: type: "string" stepId: type: "string" logLevel: type: "string" TestSetDTO: type: "object" properties: name: type: "string" key: type: "string" operationKey: type: "string" testDefinitions: type: "array" items: $ref: "#/definitions/ScopeTestDefinitionDTO" TestStepDTO: type: "object" properties: id: type: "string" scopeId: type: "string" subScopeId: type: "string" scopeDefinitionId: type: "string" scopeDefinitionKey: type: "string" scopeType: type: "string" activityId: type: "string" activityName: type: "string" activityType: type: "string" childScopeId: type: "string" childScopeType: type: "string" taskId: type: "string" transactionOrder: type: "integer" format: "int32" userId: type: "string" active: type: "boolean" enabled: type: "boolean" available: type: "boolean" completed: type: "boolean" breakpointId: type: "string" breakpointType: type: "string" actions: type: "array" items: $ref: "#/definitions/TestActionDTO" hasErrors: type: "boolean" errorMessage: type: "string" instanceIndex: type: "integer" format: "int32" TestStepResultDTO: type: "object" properties: activityId: type: "string" status: type: "string" errorMessage: type: "string" scopeDefinitionKey: type: "string" TestUserDTO: type: "object" properties: id: type: "string" userName: type: "string" firstName: type: "string" lastName: type: "string" displayName: type: "string" userDefinitionKey: type: "string" groupKeys: type: "array" items: type: "string" email: type: "string" language: type: "string" theme: type: "string" TimerJobDTO: type: "object" properties: id: type: "string" type: type: "string" activityId: type: "string" activityName: type: "string" activityType: type: "string" dueDate: type: "string" format: "date-time" attachedToActivityId: type: "string" attachedToActivityName: type: "string" TriggerMessageRequest: type: "object" properties: createTestDefinition: type: "boolean" description: "Whether a test definition needs to be created for the message\ \ request. Only used when triggering a message for a definition" description: "Request that is used for triggering a message" TriggerResultDTO: type: "object" properties: instanceId: type: "string" instanceType: type: "string" TriggerSignalRequest: type: "object" properties: createTestDefinition: type: "boolean" description: "Whether a test definition needs to be created for the signal\ \ request. Only used when triggering a signal for a definition" description: "Request that is used for triggering a signal" TriggerTimerRequest: type: "object" properties: createTestDefinition: type: "boolean" description: "Whether a test definition needs to be created for the trigger\ \ timer request. Only used when triggering a timer for a definition" description: "Request that is used for triggering a timer" UnaryTests: type: "object" properties: id: type: "string" label: type: "string" description: type: "string" extensionElements: type: "object" additionalProperties: type: "array" items: $ref: "#/definitions/DmnExtensionElement" attributes: type: "object" additionalProperties: type: "array" items: $ref: "#/definitions/DmnExtensionAttribute" text: type: "string" textValues: type: "array" items: type: "object" expressionLanguage: type: "string" UpdateInflightTestModelDTO: type: "object" properties: name: type: "string" UserDTO: type: "object" properties: id: type: "string" firstName: type: "string" lastName: type: "string" displayName: type: "string" userDefinitionKey: type: "string" email: type: "string" UserDefinitionResponse: type: "object" properties: id: type: "string" name: type: "string" key: type: "string" description: type: "string" icon: type: "string" initFormKey: type: "string" viewFormKey: type: "string" editFormKey: type: "string" allowedFeatures: type: "array" uniqueItems: true items: type: "string" translations: type: "object" additionalProperties: type: "object" additionalProperties: type: "string" tenantId: type: "string" VariableDTO: type: "object" properties: id: type: "string" scope: type: "string" name: type: "string" type: type: "string" value: type: "object" WorkDefinitionInfoDTO: type: "object" required: - "id" - "key" - "type" - "version" properties: id: type: "string" description: "The unique id" key: type: "string" description: "The key of the definition" version: type: "integer" format: "int32" description: "The version of the definition" name: type: "string" description: "Definition name" category: type: "string" description: "Definition category" description: type: "string" description: "Definition description" type: type: "string" description: "Definition type" appName: type: "string" description: "App name" appKey: type: "string" description: "App key" appIcon: type: "string" description: "App icon" appOrder: type: "integer" format: "int32" description: "App order" appColor: type: "string" description: "App color" translations: type: "object" description: "The translations for the work definition. Map having locale\ \ as the key and key value pairs for each locale." additionalProperties: type: "object" additionalProperties: type: "string" appTranslations: type: "object" description: "The translations for the app definition. Map having locale as\ \ the key and key value pairs for each locale." additionalProperties: type: "object" additionalProperties: type: "string" numberOfVersions: type: "integer" format: "int64" roles: type: "array" items: $ref: "#/definitions/InstanceRoleDTO" WorkDefinitionRepresentation: type: "object" required: - "id" - "key" - "type" - "version" properties: id: type: "string" description: "The unique id" key: type: "string" description: "The key of the definition" version: type: "integer" format: "int32" description: "The version of the definition" name: type: "string" description: "Definition name" category: type: "string" description: "Definition category" description: type: "string" description: "Definition description" type: type: "string" description: "Definition type" appName: type: "string" description: "App name" appKey: type: "string" description: "App key" appIcon: type: "string" description: "App icon" appOrder: type: "integer" format: "int32" description: "App order" appColor: type: "string" description: "App color" translations: type: "object" description: "The translations for the work definition. Map having locale\ \ as the key and key value pairs for each locale." additionalProperties: type: "object" additionalProperties: type: "string" appTranslations: type: "object" description: "The translations for the app definition. Map having locale as\ \ the key and key value pairs for each locale." additionalProperties: type: "object" additionalProperties: type: "string"