Flowable.yaml

---
swagger: '2.0'
info:
  description: "# flowable / flowəb(ə)l /\r\n\r\n- a compact and highly efficient
    workflow and Business Process Management (BPM) platform for developers, system
    admins and business users.\r\n- a lightning fast, tried and tested BPMN 2 process
    engine written in Java. It is Apache 2.0 licensed open source, with a committed
    community.\r\n- can run embedded in a Java application, or as a service on a server,
    a cluster, and in the cloud. It integrates perfectly with Spring. With a rich
    Java and REST API, it is the ideal engine for orchestrating human or system activities."
  version: v1
  title: Flowable REST API
  contact:
    name: Flowable
    url: http://www.flowable.org/
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
basePath: "/flowable-rest/service"
tags:
- name: Process Definitions
- name: Process Instances
- name: Tasks
- name: History Process
schemes:
- http
- https
paths:
  
  "/repository/process-definitions":
    get:
      tags:
      - Process Definitions
      summary: List of process definitions
      description: ''
      operationId: listProcessDefinitions
      produces:
      - application/json
      parameters:
      - name: version
        in: query
        description: Only return process definitions with the given version.
        required: false
        type: integer
      - name: name
        in: query
        description: Only return process definitions with the given name.
        required: false
        type: string
      - name: nameLike
        in: query
        description: Only return process definitions with a name like the given name.
        required: false
        type: string
      - name: nameLikeIgnoreCase
        in: query
        description: Only return process definitions with a name like the given name
          ignoring case.
        required: false
        type: string
      - name: key
        in: query
        description: Only return process definitions with the given key.
        required: false
        type: string
      - name: keyLike
        in: query
        description: Only return process definitions with a name like the given key.
        required: false
        type: string
      - name: resourceName
        in: query
        description: Only return process definitions with the given resource name.
        required: false
        type: string
      - name: resourceNameLike
        in: query
        description: Only return process definitions with a name like the given resource
          name.
        required: false
        type: string
      - name: category
        in: query
        description: Only return process definitions with the given category.
        required: false
        type: string
      - name: categoryLike
        in: query
        description: Only return process definitions with a category like the given
          name.
        required: false
        type: string
      - name: categoryNotEquals
        in: query
        description: Only return process definitions which do not have the given category.
        required: false
        type: string
      - name: deploymentId
        in: query
        description: Only return process definitions which are part of a deployment
          with the given deployment id.
        required: false
        type: string
      - name: parentDeploymentId
        in: query
        description: Only return process definitions which are part of a deployment
          with the given parent deployment id.
        required: false
        type: string
      - name: startableByUser
        in: query
        description: Only return process definitions which are part of a deployment
          with the given id.
        required: false
        type: string
      - name: latest
        in: query
        description: Only return the latest process definition versions. Can only
          be used together with key and keyLike parameters, using any other parameter
          will result in a 400-response.
        required: false
        type: boolean
      - name: suspended
        in: query
        description: If true, only returns process definitions which are suspended.
          If false, only active process definitions (which are not suspended) are
          returned.
        required: false
        type: boolean
      - name: sort
        in: query
        description: Property to sort on, to be used together with the order.
        required: false
        type: string
        enum:
        - name
        - id
        - key
        - category
        - deploymentId
        - version
      responses:
        '200':
          description: Indicates request was successful and the process-definitions
            are returned
          schema:
            "$ref": "#/definitions/DataResponseProcessDefinitionResponse"
        '400':
          description: Indicates a parameter was passed in the wrong format or that
            latest is used with other parameters other than key and keyLike. The status-message
            contains additional information.
      security:
      - basicAuth: []
  "/repository/process-definitions/{processDefinitionId}":
    get:
      tags:
      - Process Definitions
      summary: Get a process definition
      description: ''
      operationId: getProcessDefinition
      produces:
      - application/json
      parameters:
      - name: processDefinitionId
        in: path
        required: true
        type: string
      responses:
        '200':
          description: Indicates request was successful and the process-definitions
            are returned
          schema:
            "$ref": "#/definitions/ProcessDefinitionResponse"
        '404':
          description: Indicates the requested process definition was not found.
      security:
      - basicAuth: []
    put:
      tags:
      - Process Definitions
      summary: Execute actions for a process definition
      description: Execute actions for a process definition (Update category, Suspend
        or Activate)
      operationId: executeProcessDefinitionAction
      produces:
      - application/json
      parameters:
      - name: processDefinitionId
        in: path
        required: true
        type: string
      - in: body
        name: body
        required: true
        schema:
          "$ref": "#/definitions/ProcessDefinitionActionRequest"
      responses:
        '200':
          description: Indicates action has been executed for the specified process.
            (category altered, activate or suspend)
          schema:
            "$ref": "#/definitions/ProcessDefinitionResponse"
        '400':
          description: Indicates no category was defined in the request body.
        '404':
          description: Indicates the requested process definition was not found.
        '409':
          description: Indicates the requested process definition is already suspended
            or active.
      security:
      - basicAuth: []
  "/repository/process-definitions/{processDefinitionId}/model":
    get:
      tags:
      - Process Definitions
      summary: Get a process definition BPMN model
      description: ''
      operationId: getBpmnModelResource
      produces:
      - application/json
      parameters:
      - name: processDefinitionId
        in: path
        required: true
        type: string
      responses:
        '200':
          description: Indicates the process definition was found and the model is
            returned. The response contains the full process definition model.
          schema:
            "$ref": "#/definitions/BpmnModel"
        '404':
          description: Indicates the requested process definition was not found.
      security:
      - basicAuth: []
  "/runtime/process-instances":
    get:
      tags:
      - Process Instances
      summary: List process instances
      description: ''
      operationId: listProcessInstances
      produces:
      - application/json
      parameters:
      - name: id
        in: query
        description: Only return models with the given version.
        required: false
        type: string
      - name: name
        in: query
        description: Only return models with the given name.
        required: false
        type: string
      - name: nameLike
        in: query
        description: Only return models like the given name.
        required: false
        type: string
      - name: nameLikeIgnoreCase
        in: query
        description: Only return models like the given name ignoring case.
        required: false
        type: string
      - name: processDefinitionKey
        in: query
        description: Only return process instances with the given process definition
          key.
        required: false
        type: string
      - name: processDefinitionId
        in: query
        description: Only return process instances with the given process definition
          id.
        required: false
        type: string
      - name: processDefinitionCategory
        in: query
        description: Only return process instances with the given process definition
          category.
        required: false
        type: string
      - name: processDefinitionVersion
        in: query
        description: Only return process instances with the given process definition
          version.
        required: false
        type: integer
      - name: processDefinitionEngineVersion
        in: query
        description: Only return process instances with the given process definition
          engine version.
        required: false
        type: string
      - name: businessKey
        in: query
        description: Only return process instances with the given businessKey.
        required: false
        type: string
      - name: businessKeyLike
        in: query
        description: Only return process instances with the businessKey like the given
          key.
        required: false
        type: string
      - name: startedBy
        in: query
        description: Only return process instances started by the given user.
        required: false
        type: string
      - name: startedBefore
        in: query
        description: Only return process instances started before the given date.
        required: false
        type: string
        format: date-time
      - name: startedAfter
        in: query
        description: Only return process instances started after the given date.
        required: false
        type: string
        format: date-time
      - name: activeActivityId
        in: query
        description: Only return process instances which have an active activity instance
          with the provided activity id.
        required: false
        type: string
      - name: involvedUser
        in: query
        description: Only return process instances in which the given user is involved.
        required: false
        type: string
      - name: suspended
        in: query
        description: If true, only return process instance which are suspended. If
          false, only return process instances which are not suspended (active).
        required: false
        type: boolean
      - name: superProcessInstanceId
        in: query
        description: Only return process instances which have the given super process-instance
          id (for processes that have a call-activities).
        required: false
        type: string
      - name: subProcessInstanceId
        in: query
        description: Only return process instances which have the given sub process-instance
          id (for processes started as a call-activity).
        required: false
        type: string
      - name: excludeSubprocesses
        in: query
        description: Return only process instances which are not sub processes.
        required: false
        type: boolean
      - name: includeProcessVariables
        in: query
        description: Indication to include process variables in the result.
        required: false
        type: boolean
      - name: callbackId
        in: query
        description: Only return process instances with the given callbackId.
        required: false
        type: string
      - name: callbackType
        in: query
        description: Only return process instances with the given callbackType.
        required: false
        type: string
      - name: tenantId
        in: query
        description: Only return process instances with the given tenantId.
        required: false
        type: string
      - name: tenantIdLike
        in: query
        description: Only return process instances with a tenantId like the given
          value.
        required: false
        type: string
      - name: withoutTenantId
        in: query
        description: If true, only returns process instances without a tenantId set.
          If false, the withoutTenantId parameter is ignored.
        required: false
        type: boolean
      - name: sort
        in: query
        description: Property to sort on, to be used together with the order.
        required: false
        type: string
        enum:
        - id
        - processDefinitionId
        - tenantId
        - processDefinitionKey
      responses:
        '200':
          description: Indicates request was successful and the process-instances
            are returned
          schema:
            "$ref": "#/definitions/DataResponseProcessInstanceResponse"
        '400':
          description: Indicates a parameter was passed in the wrong format . The
            status-message contains additional information.
      security:
      - basicAuth: []
    post:
      tags:
      - Process Instances
      summary: Start a process instance
      description: "Note that also a *transientVariables* property is accepted as
        part of this json, that follows the same structure as the *variables* property.\n\nOnly
        one of *processDefinitionId*, *processDefinitionKey* or *message* can be used
        in the request body. \n\nParameters *businessKey*, *variables* and *tenantId*
        are optional.\n\n If tenantId is omitted, the default tenant will be used.
        More information about the variable format can be found in the REST variables
        section.\n\n Note that the variable-scope that is supplied is ignored, process-variables
        are always local.\n\n"
      operationId: createProcessInstance
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        required: false
        schema:
          "$ref": "#/definitions/ProcessInstanceCreateRequest"
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ProcessInstanceResponse"
        '201':
          description: Indicates the process instance was created.
        '400':
          description: Indicates either the process-definition was not found (based
            on id or key), no process is started by sending the given message or an
            invalid variable has been passed. Status description contains additional
            information about the error.
      security:
      - basicAuth: []
  "/runtime/process-instances/{processInstanceId}":
    get:
      tags:
      - Process Instances
      summary: Get a process instance
      description: ''
      operationId: getProcessInstance
      produces:
      - application/json
      parameters:
      - name: processInstanceId
        in: path
        required: true
        type: string
      responses:
        '200':
          description: Indicates the process instance was found and returned.
          schema:
            "$ref": "#/definitions/ProcessInstanceResponse"
        '404':
          description: Indicates the requested process instance was not found.
      security:
      - basicAuth: []
    put:
      tags:
      - Process Instances
      summary: Update process instance properties or execute an action on a process
        instance (body needs to contain an 'action' property for the latter).
      description: ''
      operationId: updateProcessInstance
      produces:
      - application/json
      parameters:
      - name: processInstanceId
        in: path
        required: true
        type: string
      - in: body
        name: body
        required: false
        schema:
          "$ref": "#/definitions/ProcessInstanceUpdateRequest"
      responses:
        '200':
          description: Indicates the process instance was found and the update/action
            was executed.
          schema:
            "$ref": "#/definitions/ProcessInstanceResponse"
        '400':
          description: Indicates a invalid parameters are supplied.
        '404':
          description: Indicates the requested process instance was not found.
        '409':
          description: Indicates the requested process instance change cannot be executed
            since the process-instance is in a wrong status which doesn't accept the
            change
      security:
      - basicAuth: []
    delete:
      tags:
      - Process Instances
      summary: Delete a process instance
      description: ''
      operationId: deleteProcessInstance
      parameters:
      - name: processInstanceId
        in: path
        required: true
        type: string
      - name: deleteReason
        in: query
        required: false
        type: string
      responses:
        '204':
          description: Indicates the process instance was found and deleted. Response
            body is left empty intentionally.
        '404':
          description: Indicates the requested process instance was not found.
      security:
      - basicAuth: []
  "/runtime/tasks":
    get:
      tags:
      - Tasks
      summary: List of tasks
      description: ''
      operationId: listTasks
      produces:
      - application/json
      parameters:
      - name: name
        in: query
        description: Only return models with the given version.
        required: false
        type: string
      - name: nameLike
        in: query
        description: Only return tasks with a name like the given name.
        required: false
        type: string
      - name: description
        in: query
        description: Only return tasks with the given description.
        required: false
        type: string
      - name: priority
        in: query
        description: Only return tasks with the given priority.
        required: false
        type: string
      - name: minimumPriority
        in: query
        description: Only return tasks with a priority greater than the given value.
        required: false
        type: string
      - name: maximumPriority
        in: query
        description: Only return tasks with a priority lower than the given value.
        required: false
        type: string
      - name: assignee
        in: query
        description: Only return tasks assigned to the given user.
        required: false
        type: string
      - name: assigneeLike
        in: query
        description: Only return tasks assigned with an assignee like the given value.
        required: false
        type: string
      - name: owner
        in: query
        description: Only return tasks owned by the given user.
        required: false
        type: string
      - name: ownerLike
        in: query
        description: Only return tasks assigned with an owner like the given value.
        required: false
        type: string
      - name: unassigned
        in: query
        description: Only return tasks that are not assigned to anyone. If false is
          passed, the value is ignored.
        required: false
        type: string
      - name: delegationState
        in: query
        description: Only return tasks that have the given delegation state. Possible
          values are pending and resolved.
        required: false
        type: string
      - name: candidateUser
        in: query
        description: Only return tasks that can be claimed by the given user. This
          includes both tasks where the user is an explicit candidate for and task
          that are claimable by a group that the user is a member of.
        required: false
        type: string
      - name: candidateGroup
        in: query
        description: Only return tasks that can be claimed by a user in the given
          group.
        required: false
        type: string
      - name: candidateGroups
        in: query
        description: Only return tasks that can be claimed by a user in the given
          groups. Values split by comma.
        required: false
        type: string
      - name: involvedUser
        in: query
        description: Only return tasks in which the given user is involved.
        required: false
        type: string
      - name: taskDefinitionKey
        in: query
        description: Only return tasks with the given task definition id.
        required: false
        type: string
      - name: taskDefinitionKeyLike
        in: query
        description: Only return tasks with a given task definition id like the given
          value.
        required: false
        type: string
      - name: taskDefinitionKeys
        in: query
        description: Only return tasks with the given task definition ids.
        required: false
        type: string
      - name: processInstanceId
        in: query
        description: Only return tasks which are part of the process instance with
          the given id.
        required: false
        type: string
      - name: processInstanceIdWithChildren
        in: query
        description: Only return tasks which are part of the process instance and
          its children with the given id.
        required: false
        type: string
      - name: withoutProcessInstanceId
        in: query
        description: If true, only returns tasks without a process instance id set.
          If false, the withoutProcessInstanceId parameter is ignored.
        required: false
        type: boolean
      - name: processInstanceBusinessKey
        in: query
        description: Only return tasks which are part of the process instance with
          the given business key.
        required: false
        type: string
      - name: processInstanceBusinessKeyLike
        in: query
        description: Only return tasks which are part of the process instance which
          has a business key like the given value.
        required: false
        type: string
      - name: processDefinitionId
        in: query
        description: Only return tasks which are part of a process instance which
          has a process definition with the given id.
        required: false
        type: string
      - name: processDefinitionKey
        in: query
        description: Only return tasks which are part of a process instance which
          has a process definition with the given key.
        required: false
        type: string
      - name: processDefinitionKeyLike
        in: query
        description: Only return tasks which are part of a process instance which
          has a process definition with a key like the given value.
        required: false
        type: string
      - name: processDefinitionName
        in: query
        description: Only return tasks which are part of a process instance which
          has a process definition with the given name.
        required: false
        type: string
      - name: processDefinitionNameLike
        in: query
        description: Only return tasks which are part of a process instance which
          has a process definition with a name like the given value.
        required: false
        type: string
      - name: executionId
        in: query
        description: Only return tasks which are part of the execution with the given
          id.
        required: false
        type: string
      - name: createdOn
        in: query
        description: Only return tasks which are created on the given date.
        required: false
        type: string
        format: date-time
      - name: createdBefore
        in: query
        description: Only return tasks which are created before the given date.
        required: false
        type: string
        format: date-time
      - name: createdAfter
        in: query
        description: Only return tasks which are created after the given date.
        required: false
        type: string
        format: date-time
      - name: dueOn
        in: query
        description: Only return tasks which are due on the given date.
        required: false
        type: string
        format: date-time
      - name: dueBefore
        in: query
        description: Only return tasks which are due before the given date.
        required: false
        type: string
        format: date-time
      - name: dueAfter
        in: query
        description: Only return tasks which are due after the given date.
        required: false
        type: string
        format: date-time
      - name: withoutDueDate
        in: query
        description: Only return tasks which do not have a due date. The property
          is ignored if the value is false.
        required: false
        type: boolean
      - name: excludeSubTasks
        in: query
        description: Only return tasks that are not a subtask of another task.
        required: false
        type: boolean
      - name: active
        in: query
        description: If true, only return tasks that are not suspended (either part
          of a process that is not suspended or not part of a process at all). If
          false, only tasks that are part of suspended process instances are returned.
        required: false
        type: boolean
      - name: includeTaskLocalVariables
        in: query
        description: Indication to include task local variables in the result.
        required: false
        type: boolean
      - name: includeProcessVariables
        in: query
        description: Indication to include process variables in the result.
        required: false
        type: boolean
      - name: scopeDefinitionId
        in: query
        description: Only return tasks with the given scopeDefinitionId.
        required: false
        type: string
      - name: scopeId
        in: query
        description: Only return tasks with the given scopeId.
        required: false
        type: string
      - name: withoutScopeId
        in: query
        description: If true, only returns tasks without a scope id set. If false,
          the withoutScopeId parameter is ignored.
        required: false
        type: boolean
      - name: scopeType
        in: query
        description: Only return tasks with the given scopeType.
        required: false
        type: string
      - name: propagatedStageInstanceId
        in: query
        description: Only return tasks which have the given id as propagated stage
          instance id
        required: false
        type: string
      - name: tenantId
        in: query
        description: Only return tasks with the given tenantId.
        required: false
        type: string
      - name: tenantIdLike
        in: query
        description: Only return tasks with a tenantId like the given value.
        required: false
        type: string
      - name: withoutTenantId
        in: query
        description: If true, only returns tasks without a tenantId set. If false,
          the withoutTenantId parameter is ignored.
        required: false
        type: boolean
      - name: candidateOrAssigned
        in: query
        description: Select tasks that has been claimed or assigned to user or waiting
          to claim by user (candidate user or groups).
        required: false
        type: string
      - name: category
        in: query
        description: 'Select tasks with the given category. Note that this is the
          task category, not the category of the process definition (namespace within
          the BPMN Xml).

          '
        required: false
        type: string
      responses:
        '200':
          description: Indicates request was successful and the tasks are returned
          schema:
            "$ref": "#/definitions/DataResponseTaskResponse"
        '404':
          description: Indicates a parameter was passed in the wrong format or that
            delegationState has an invalid value (other than pending and resolved).
            The status-message contains additional information.
      security:
      - basicAuth: []
    post:
      tags:
      - Tasks
      summary: Create Task
      description: ''
      operationId: createTask
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        required: false
        schema:
          "$ref": "#/definitions/TaskRequest"
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/TaskResponse"
        '201':
          description: Indicates request was successful and the tasks are returned
        '400':
          description: Indicates a parameter was passed in the wrong format or that
            delegationState has an invalid value (other than pending and resolved).
            The status-message contains additional information.
      security:
      - basicAuth: []
  "/runtime/tasks/{taskId}":
    get:
      tags:
      - Tasks
      summary: Get a task
      description: ''
      operationId: getTask
      produces:
      - application/json
      parameters:
      - name: taskId
        in: path
        required: true
        type: string
      responses:
        '200':
          description: Indicates the task was found and returned.
          schema:
            "$ref": "#/definitions/TaskResponse"
        '404':
          description: Indicates the requested task was not found.
      security:
      - basicAuth: []
    post:
      tags:
      - Tasks
      summary: Tasks actions
      description: ''
      operationId: executeTaskAction
      parameters:
      - name: taskId
        in: path
        required: true
        type: string
      - in: body
        name: body
        required: false
        schema:
          "$ref": "#/definitions/TaskActionRequest"
      responses:
        '200':
          description: Indicates the action was executed.
        '400':
          description: When the body contains an invalid value or when the assignee
            is missing when the action requires it.
        '404':
          description: Indicates the requested task was not found.
        '409':
          description: Indicates the action cannot be performed due to a conflict.
            Either the task was updates simultaneously or the task was claimed by
            another user, in case of the claim action.
      security:
      - basicAuth: []
    put:
      tags:
      - Tasks
      summary: Update a task
      description: 'All request values are optional. For example, you can only include
        the assignee attribute in the request body JSON-object, only updating the
        assignee of the task, leaving all other fields unaffected. When an attribute
        is explicitly included and is set to null, the task-value will be updated
        to null. Example: {"dueDate" : null} will clear the duedate of the task).'
      operationId: updateTask
      produces:
      - application/json
      parameters:
      - name: taskId
        in: path
        required: true
        type: string
      - in: body
        name: body
        required: false
        schema:
          "$ref": "#/definitions/TaskRequest"
      responses:
        '200':
          description: Indicates the task was updated.
          schema:
            "$ref": "#/definitions/TaskResponse"
        '404':
          description: Indicates the requested task was not found.
        '409':
          description: Indicates the requested task was updated simultaneously.
      security:
      - basicAuth: []
    delete:
      tags:
      - Tasks
      summary: Delete a task
      description: ''
      operationId: deleteTask
      parameters:
      - name: taskId
        in: path
        required: true
        type: string
      - name: cascadeHistory
        in: query
        description: Whether or not to delete the HistoricTask instance when deleting
          the task (if applicable). If not provided, this value defaults to false.
        required: false
        type: string
      - name: deleteReason
        in: query
        description: Reason why the task is deleted. This value is ignored when cascadeHistory
          is true.
        required: false
        type: string
      responses:
        '204':
          description: Indicates the task was found and has been deleted. Response-body
            is intentionally empty.
        '403':
          description: Indicates the requested task cannot be deleted because it’s
            part of a workflow.
        '404':
          description: Indicates the requested task was not found.
      security:
      - basicAuth: []
  "/history/historic-process-instances":
    get:
      tags:
      - History Process
      summary: List of historic process instances
      description: ''
      operationId: listHistoricProcessInstances
      produces:
      - application/json
      parameters:
      - name: processInstanceId
        in: query
        description: An id of the historic process instance.
        required: false
        type: string
      - name: processInstanceName
        in: query
        description: A name of the historic process instance.
        required: false
        type: string
      - name: processInstanceNameLike
        in: query
        description: A name of the historic process instance used in a like query.
        required: false
        type: string
      - name: processInstanceNameLikeIgnoreCase
        in: query
        description: A name of the historic process instance used in a like query
          ignoring case.
        required: false
        type: string
      - name: processDefinitionKey
        in: query
        description: The process definition key of the historic process instance.
        required: false
        type: string
      - name: processDefinitionId
        in: query
        description: The process definition id of the historic process instance.
        required: false
        type: string
      - name: processDefinitionName
        in: query
        description: The process definition name of the historic process instance.
        required: false
        type: string
      - name: processDefinitionCategory
        in: query
        description: The process definition category of the historic process instance.
        required: false
        type: string
      - name: processDefinitionVersion
        in: query
        description: The process definition version of the historic process instance.
        required: false
        type: string
      - name: deploymentId
        in: query
        description: The deployment id of the historic process instance.
        required: false
        type: string
      - name: businessKey
        in: query
        description: The business key of the historic process instance.
        required: false
        type: string
      - name: businessKeyLike
        in: query
        description: Only return instances with a businessKey like this key.
        required: false
        type: string
      - name: activeActivityId
        in: query
        description: Only return instances which have an active activity instance
          with the provided activity id.
        required: false
        type: string
      - name: involvedUser
        in: query
        description: An involved user of the historic process instance.
        required: false
        type: string
      - name: finished
        in: query
        description: Indication if the historic process instance is finished.
        required: false
        type: boolean
      - name: superProcessInstanceId
        in: query
        description: An optional parent process id of the historic process instance.
        required: false
        type: string
      - name: excludeSubprocesses
        in: query
        description: Return only historic process instances which are not sub processes.
        required: false
        type: boolean
      - name: finishedAfter
        in: query
        description: Return only historic process instances that were finished after
          this date.
        required: false
        type: string
        format: date-time
      - name: finishedBefore
        in: query
        description: Return only historic process instances that were finished before
          this date.
        required: false
        type: string
        format: date-time
      - name: startedAfter
        in: query
        description: Return only historic process instances that were started after
          this date.
        required: false
        type: string
        format: date-time
      - name: startedBefore
        in: query
        description: Return only historic process instances that were started before
          this date.
        required: false
        type: string
        format: date-time
      - name: startedBy
        in: query
        description: Return only historic process instances that were started by this
          user.
        required: false
        type: string
      - name: includeProcessVariables
        in: query
        description: An indication if the historic process instance variables should
          be returned as well.
        required: false
        type: boolean
      - name: callbackId
        in: query
        description: Only return instances with the given callbackId.
        required: false
        type: string
      - name: callbackType
        in: query
        description: Only return instances with the given callbackType.
        required: false
        type: string
      - name: withoutCallbackId
        in: query
        description: Only return instances that do not have a callbackId.
        required: false
        type: boolean
      - name: tenantId
        in: query
        description: Only return instances with the given tenantId.
        required: false
        type: string
      - name: tenantIdLike
        in: query
        description: Only return instances with a tenantId like the given value.
        required: false
        type: string
      - name: withoutTenantId
        in: query
        description: 'If true, only returns instances without a tenantId set. If false,
          the withoutTenantId parameter is ignored.

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