Camunda User Tasks API

The User Tasks API from Camunda — 3 operation(s) for user tasks.

OpenAPI Specification

camunda-user-tasks-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Camunda 8 REST Cluster User Tasks API
  description: The Camunda 8 REST API provides endpoints for managing process instances, jobs, decisions, deployments, messages, signals, and other resources in the Camunda 8 process orchestration platform.
  version: 8.6.0
  contact:
    name: Camunda
    url: https://camunda.com/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: '{baseUrl}/v2'
  description: Camunda 8 Self-Managed or SaaS
  variables:
    baseUrl:
      default: http://localhost:8080
security:
- BearerAuth: []
tags:
- name: User Tasks
paths:
  /user-tasks/search:
    post:
      operationId: searchUserTasks
      summary: Search user tasks
      description: Search for user tasks based on provided criteria.
      tags:
      - User Tasks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchRequest'
      responses:
        '200':
          description: Successful response
  /user-tasks/{userTaskKey}/assignment:
    post:
      operationId: assignUserTask
      summary: Assign a user task
      description: Assigns a user task to a specific assignee.
      tags:
      - User Tasks
      parameters:
      - name: userTaskKey
        in: path
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                assignee:
                  type: string
                allowOverride:
                  type: boolean
      responses:
        '204':
          description: Task assigned
  /user-tasks/{userTaskKey}/completion:
    post:
      operationId: completeUserTask
      summary: Complete a user task
      description: Completes a user task with optional variables.
      tags:
      - User Tasks
      parameters:
      - name: userTaskKey
        in: path
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                variables:
                  type: object
      responses:
        '204':
          description: Task completed
components:
  schemas:
    SearchRequest:
      type: object
      properties:
        filter:
          type: object
        sort:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              order:
                type: string
                enum:
                - ASC
                - DESC
        page:
          type: object
          properties:
            from:
              type: integer
            limit:
              type: integer
            searchAfter:
              type: array
              items: {}
            searchBefore:
              type: array
              items: {}
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer