Camunda Docs
  • Get Started
  • BPM Platform
  • Optimize
  • Enterprise
  • Camunda.org
BPM Platform 7.6
  • Introduction
    • Download
    • Implemented Standards
    • Architecture Overview
    • Supported Environments
    • Extensions
    • Third-Party Libraries
    • Public API
  • User Guide
    • Process Engine
      • Process Engine Bootstrapping
      • Process Engine API
      • Process Engine Concepts
      • Process Variables
      • Process Instance Modification
      • Delegation Code
      • Expression Language
      • Scripting
      • Templating
      • Custom Code & Security
      • External Tasks
      • Connectors
      • Process Versioning
      • Process Instance Migration
      • Database
      • History and Audit Event Log
      • Deployment Cache
      • Transactions in Processes
      • The Job Executor
      • Multi-Tenancy
      • Id Generators
      • Metrics
      • Incidents
      • Process Engine Plugins
      • Identity Service
      • Authorization Service
      • Deployments
      • Process Diagram Visualization
      • Decisions
        • Configuration
        • Repository
        • Decision Service
        • Decisions in BPMN & CMMN
        • History
      • Batch
        • Batch operations
    • Process Applications
      • The Process Application class
      • The processes.xml Deployment Descriptor
      • Process Application Event Listeners
      • Process Application Resource Access
      • Maven Project Templates (Archetypes)
    • Runtime Container Integration
      • BPM Platform Services
      • JNDI Bindings for BPM Platform Services
      • Apache Tomcat
      • JBoss/WildFly
    • Spring Framework Integration
      • Bootstrapping
      • Transactions
      • Deployment
      • Expression Resolving
      • Testing
    • CDI and Java EE Integration
      • JTA Transaction Integration
      • Expression Resolving
      • Contextual Programming Model
      • Built-In Beans
      • CDI Event Bridge
    • Testing
    • Model API
      • BPMN Model API
        • Read a Model
        • Create a Model
        • Delegation Code
        • Fluent Builder API
        • Repository Service
        • Extension Elements
      • CMMN Model API
        • Read a Model
        • Create a Model
        • Delegation Code
        • Repository Service
        • Extension Elements
        • Limitations
    • Data Formats (XML, JSON, Other)
      • Configuring Spin Integration
      • Data Formats in Processes
      • XML
      • JSON
    • User Task Forms
    • DMN Engine
      • Embed
      • Evaluate Decisions
      • Expressions
      • Data Types
      • Testing
    • Logging
  • Reference
    • Rest Api
      • Overview
        • Configure Authentication
        • Usage with a Pre-Built Distribution
        • Embed the API
        • Hypertext Application Language (HAL)
        • Variables in the REST API
        • Custom Date Format
      • Authorization
        • Get List
        • Get List Count
        • Get
        • Check
        • Options
        • Create
        • Update
        • Delete
      • Batch
        • Get List
        • Get List Count
        • Get
        • Activate/Suspend
        • Delete
        • Get Statistics
        • Get Statistics Count
      • Case Definition
        • Get List
        • Get List Count
        • Get
        • Get XML
        • Get Diagram
        • Create
      • Case Execution
        • Local Variables
          • Get
          • Get (Binary)
          • Get List
          • Update
          • Update (Binary)
          • Modify
          • Delete
        • Variables
          • Get
          • Get (Binary)
          • Get List
          • Post (Binary)
          • Update
          • Modify
          • Delete
        • Get List
        • Get Count
        • Get
        • Get List (POST)
        • Get Count (Post)
        • Start
        • Complete
        • Disable
        • Re-enable
        • Terminate
      • Case Instance
        • Variables
          • Get List
          • Get
          • Get (Binary)
          • Modify
          • Update
          • POST (Binary)
          • Delete
        • Get List
        • Get List Count
        • Get
        • Get List (POST)
        • Get List Count (POST)
        • Complete
        • Close
        • Terminate
      • Decision Definition
        • Get List
        • Get List Count
        • Get
        • Get XML
        • Get Diagram
        • Evaluate
      • Decision Requirements Definition
        • Get List
        • Get List Count
        • Get
        • Get DMN XML
        • Get diagram
      • Deployment
        • Get List
        • Get List Count
        • Get
        • Create
        • Redeploy
        • Get Resources
        • Get Resource
        • Get Resource (Binary)
        • Delete
      • Engine
        • Get List
      • Execution
        • Local Variables
          • Get List
          • Get
          • Get (Binary)
          • Update
          • Post (Binary)
          • Modify
          • Delete
        • Message Event Subscription
          • Get
          • Trigger
        • Get List
        • Get List Count
        • Get
        • Get (POST)
        • Get List Count (POST)
        • Trigger
      • External Task
        • Get
        • Get List
        • Get List Count
        • Get List (POST)
        • Get List Count (POST)
        • Fetch and Lock
        • Complete
        • Handle BPMN Error
        • Handle Failure
        • Unlock
        • Set Priority
        • Set Retries
      • Filter
        • Get List
        • Get List Count
        • Get
        • Create
        • Update
        • Delete
        • Execute
        • Execute (POST)
        • Execute List
        • Execute List (POST)
        • Execute Count
        • Execute Count (POST)
        • Options
      • Group
        • Group Member
          • Create
          • Delete
          • Options
        • Get List
        • Get List Count
        • Get
        • Create
        • Update
        • Options
        • Delete
      • History
        • Activity Instance
          • Get List
          • Get List Count
          • Get
          • Get List (POST)
          • Get List Count (POST)
        • Batch
          • Get List
          • Get List Count
          • Get
          • Delete
        • Case Definition
          • Get Historic Case Activity Statistics
        • Case Instance
          • Get List
          • Get List Count
          • Get
          • Get List (POST)
          • Get List Count (POST)
        • Case Activity Instance
          • Get List
          • Get List Count
          • Get
        • Decision Instance
          • Get List
          • Get List Count
          • Get
        • Decision Requirements Definition
          • Get Historic Decision Instance Statistics
        • Detail
          • Get List
          • Get List Count
          • Get
          • Get (Binary)
        • Identity link log
          • Get List
          • Get List Count
        • Incident
          • Get List
          • Get List Count
        • Job Log
          • Get List
          • Get List Count
          • Get
          • Get Stacktrace
          • Get List Count (POST)
          • Get List (POST)
        • Process Definition
          • Get Historic Activity Statistics
        • Process Instance
          • Get List
          • Get List Count
          • Get
          • Get List (POST)
          • Get List Count (POST)
          • Delete
          • Get Duration Report
          • Delete Async (POST)
        • Task
          • Get List
          • Get List Count
          • Get List (POST)
          • Get List Count (POST)
          • Get Task Report
        • User Operation Log
          • Get List
          • Get List Count
        • Variable Instance
          • Get List
          • Get List Count
          • Get
          • Get (Binary)
          • Get List (POST)
          • Get List Count (POST)
      • Identity
        • Get Groups
      • Incident
        • Get List
        • Get List Count
      • Job
        • Get List
        • Get List Count
        • Get
        • Get List (POST)
        • Get List Count (POST)
        • Execute
        • Update Due Date
        • Update Priority
        • Update Retries
        • Get Stacktrace
        • Activate/Suspend By Id
        • Set Job Retries Async (POST)
        • Activate/Suspend by Job Definition Id
        • Activate/Suspend By Process Definition Id
        • Activate/Suspend By Process Definition Key
        • Activate/Suspend By Process Instance Id
        • Delete Job
      • Job Definition
        • Get List
        • Get List Count
        • Get
        • Get List (POST)
        • Get List Count (POST)
        • Set Priority
        • Set Retries
        • Activate/Suspend By Id
        • Activate/Suspend By Process Definition Id
        • Activate/Suspend By Process Definition Key
      • Message
        • Correlate
      • Metrics
        • Get Metrics in Interval
        • Get Sum
      • Migration
        • Generate
        • Validate
        • Execute
        • Execute Async (Batch)
      • Process Definition
        • Get Activity Instance Statistics
        • Get Diagram
        • Get Start Form Variables
        • Get List Count
        • Get List
        • Get Rendered Start Form
        • Get Start Form Key
        • Get Process Instance Statistics
        • Get XML
        • Get
        • Start Instance
        • Submit Start Form
        • Activate/Suspend By Id
        • Activate/Suspend By Key
        • Delete
      • Process Instance
        • Variables
          • Delete
          • Get (Binary)
          • Get
          • Get List
          • Post (Binary)
          • Modify
          • Update
        • Delete
        • Get Activity Instance
        • Get List Count
        • Get List
        • Get
        • Modify
        • Delete Async (POST)
        • Delete Async Historic Query Based (POST)
        • Get List Count (POST)
        • Set Job Retries Async (POST)
        • Set Job Retries Async Historic Query Based (POST)
        • Get List (POST)
        • Activate/Suspend By Id
        • Activate/Suspend By Process Definition Id
        • Activate/Suspend By Process Definition Key
      • Task
        • Comment
          • Get List
          • Get
          • Create
        • Attachment
          • Get List
          • Get
          • Create
          • Get (Binary)
          • Delete
        • Identity Links
          • Get List
          • Add
          • Delete
        • Variables
          • Get
          • Get (Binary)
          • Get List
          • Modify
          • Update
          • Post (Binary)
          • Delete
        • Local Variables
          • Get
          • Get (Binary)
          • Get List
          • Modify
          • Update
          • Post (Binary)
          • Delete
        • Report
          • Get Task Count By Candidate Group
        • Get
        • Get List
        • Get List (POST)
        • Get List Count
        • Get List Count (POST)
        • Get Form Key
        • Claim
        • Unclaim
        • Complete
        • Submit Form
        • Resolve
        • Set Assignee
        • Delegate
        • Get Rendered Form
        • Get Task Form Variables
        • Create
        • Update
      • Tenant
        • Tenant User Membership
          • Create
          • Delete
          • Options
        • Tenant Group Membership
          • Create
          • Delete
          • Options
        • Get List
        • Get List Count
        • Get
        • Create
        • Update
        • Options
        • Delete
      • User
        • Delete
        • Get List Count
        • Get List
        • Get Profile
        • Options
        • Create
        • Update Credentials
        • Update Profile
      • Variable Instance
        • Get (Binary)
        • Get List Count
        • Get List
        • Get
        • Get List (POST)
        • Get List Count (POST)
    • Javadoc
    • BPMN 2.0
      • Tasks
        • Service Task
        • Send Task
        • User Task
        • Business Rule Task
        • Script Task
        • Receive Task
        • Manual Task
        • Task Markers
      • Gateways
        • Data-based Exclusive Gateway (XOR)
        • Conditional and Default Sequence Flows
        • Parallel Gateway
        • Inclusive Gateway
        • Event-based Gateway
      • Events
        • Start Events
        • None Events
        • Message Events
        • Timer Events
        • Error Events
        • Escalation Events
        • Signal Events
        • Cancel and Compensation Events
        • Conditional Events
        • Link Events
        • Terminate Events
      • Subprocess
        • Embedded Subprocess
        • Call Activity
        • Event Subprocess
        • Transaction Subprocess
      • Extension Reference
        • Extension Elements
        • Extension Attributes
    • DMN 1.1
      • Decision Table
        • Input
        • Output
        • Rule
        • Hit Policy
      • Decision Literal Expression
      • Decision Requirements Graph
      • FEEL
        • Data Types
        • Language Elements
      • Extension Reference
        • Extension Attributes
    • CMMN 1.1
      • Classic vs Fluent API
      • CMMN Concepts
        • Plan Items and Item Definitions
        • Plan Item Lifecycles
        • Entry and Exit Criteria
      • Tasks
        • Human Task
        • Process Task
        • Case Task
        • Decision Task
      • Grouping Tasks
        • Stage
      • Milestones
      • Sentries
      • Markers
        • Manual Activation Rule
        • Required Rule
        • Auto Complete
        • Repetition Rule
      • Extension Reference
        • Extension Elements
        • Extension Attributes
      • Migration between Specification Versions
        • 1.0 to 1.1
    • Forms
      • Controls
        • Text Inputs
        • Textareas
        • Date Inputs
        • Boolean Inputs
        • Selects
        • Hidden Input Fields
        • File Upload and Download
      • Javascript
        • The cam-script Directive
        • Available API
        • Participating in the Form Lifecycle
        • Debugging Scripts
        • Generating a Business Key
        • Examples
      • Lifecycle and Events
      • Working with Json Data
      • Working with Java Objects
      • Integrating the Forms SDK
        • Getting a Distribution
        • Bootstrapping
        • AngularJS Integration
        • Full Example
    • Spin Dataformats
      • XML
        • Reading XML
        • Manipulating XML
        • Writing XML
        • Querying XML
        • Mapping XML
        • Configuring XML Handling
      • JSON
        • Reading JSON
        • Writing JSON
        • Querying JSON
        • Mapping JSON
        • Configuring JSON Handling
      • Extending Spin
    • Connectors
      • HTTP Connector
      • SOAP Connector
      • Extending Connect
    • Deployment Descriptors
      • bpm-platform.xml
      • processes.xml
      • Tags
        • <job-executor />
        • <process-archive />
        • <process-engine />
  • Installation
    • Camunda Modeler
    • Full Distribution
      • Tomcat
        • Pre-Packaged Distribution
        • Manual Installation
        • Configuration
      • JBoss/Wildfly
        • Pre-Packaged Distribution
        • Manual Installation
        • Configuration
      • IBM WebSphere
        • Manual Installation
        • Configuration
      • Oracle WebLogic
        • Manual Installation
        • Configuration
    • Docker
    • Standalone Webapplication (.war)
    • Karaf / OSGi
    • Cycle
  • Modeler
    • Camunda Modeler
      • BPMN
      • CMMN
      • DMN
      • Element Templates
      • Tips and Tricks
    • Eclipse Plugin (Deprecated)
      • Update Sites
      • Installation
      • Modeling BPMN
      • Extensions
  • Web Applications
    • Admin
      • User Management
      • Group Management
      • Tenant Management
      • Authorization Management
      • System Management
      • Configuration
      • Extending
        • Plugins
    • Cockpit
      • Dashboard
      • BPMN Processes
        • Dashboard
        • Process Definition View
        • Process Instance View
        • History
        • Instance Modification
        • Instance Migration
        • Failed Jobs
        • Suspension
      • DMN Decisions
        • Dashboard
        • Decision Definition View
        • Decision Requirements Definition Instance View
        • Decision Requirements Definition View
        • Decision Instance View
        • Live Editing
      • CMMN Cases
        • Dashboard
        • Case Definition View
        • Case Instance View
      • Deployments
      • Auditing
      • Batch
        • Batch operation
        • Batch View
      • Reports
      • Open Tasks Dashboard
      • Extending
        • Configuration
        • Plugins
    • Tasklist
      • Working with Tasklist
      • Dashboard
      • Filters
      • User Assignment
      • Task Lifecycle
      • Plugins
      • Configuration
      • Accessibility
    • Welcome
      • Plugins
      • Configuration
    • Cycle
  • Examples & Tutorials
    • Tutorials
      • Error Handling
      • Custom Queries
      • Multi-Tenancy
      • JSF Task Forms
      • Communication among Processes using Web Services
      • How to develop a Cockpit plugin
  • Update & Migration
    • Minor Version Update
      • 7.5 to 7.6
        • JBoss AS/Wildfly
        • Tomcat
        • Web Application Plugins
        • WebLogic
        • WebSphere
      • 7.4 to 7.5
        • Glassfish
        • JBoss AS/Wildfly
        • Tomcat
        • Web Application Plugins
        • WebLogic
        • WebSphere
      • 7.3 to 7.4
        • Glassfish
        • JBoss AS/Wildfly
        • Tomcat
        • WebLogic
        • WebSphere
      • 7.2 to 7.3
        • Glassfish
        • JBoss
        • Tomcat
        • WebLogic
        • WebSphere
      • 7.1 to 7.2
        • Glassfish
        • JBoss
        • Tomcat
        • WebLogic
        • Websphere
      • 7.0 to 7.1
    • Patch Level Update
    • Rolling Update
    • Activiti Migration
    • Camunda Fox Migration

Options

Edit on Github

Rest Api Reference

Overview
Authorization
Batch
Case Definition
Case Execution
Case Instance
Decision Definition
Decision Requirements Definition
Deployment
Engine
Execution
External Task
Filter
Group
History
Identity
Incident
Job
Job Definition
Message
Metrics
Migration
Process Definition
Process Instance
Task
Tenant
User
Variable Instance

We are looking for talented people.

Check out our open positions.

Back to top

camunda.org and docs.camunda.org are part of Camunda Platform | Built by camunda and contributors — Privacy Statement — camunda Services GmbH © 2021

Creative Commons License The content on this site is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.