Camunda 7 Docs
  • Get Started
  • Camunda Platform 7
  • Optimize
  • Cawemo
  • Enterprise
  • Security
  • Camunda.org
Camunda Platform 7 7.18 (7.18)
  • Introduction
    • Download
    • Licenses
    • Implemented Standards
    • Architecture Overview
    • Supported Environments
    • Telemetry
    • Extensions
    • Third-Party Libraries
      • Camunda Platform License Book
      • Camunda Platform RPA Bridge License Book
    • Public API
  • User Guide
    • Process Engine
      • Process Engine Bootstrapping
      • Process Engine API
      • Process Engine Concepts
      • Process Variables
      • Process Instance Modification
      • Process Instance Restart
      • Delegation Code
      • Expression Language
      • Scripting
      • Templating
      • Custom Code & Security
      • External Tasks
      • Connectors
      • Process Versioning
      • Process Instance Migration
      • Database
        • Database Schema
        • Database Configuration
        • Microsoft SQL Server and Azure SQL Database Configuration
        • CockroachDB Database Configuration
        • MySQL Database Configuration
        • Performance
      • History and Audit Event Log
      • Deployment Cache
      • Password Hashing
      • Password Policy
      • Transactions in Processes
      • The Job Executor
      • Multi-Tenancy
      • Id Generators
      • Metrics
      • Incidents
      • Process Engine Plugins
      • Identity Service
      • Authorization Service
      • Deployments
      • Process Diagram Visualization
      • Time zones
      • Decisions
        • Configuration
        • Repository
        • Decision Service
        • Decisions in BPMN & CMMN
        • History
      • Batch
        • Batch operations
      • Error Handling
    • 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
      • Camunda Platform Services
      • JNDI Bindings for Camunda Platform Services
      • Apache Tomcat
      • WildFly
      • Job Execution with Managed Resources
    • Camunda Platform Run
    • Spring Framework Integration
      • Bootstrapping
      • Transactions
      • Deployment
      • Spring Bean Resolving
      • Testing
    • Spring Boot Integration
      • Version Compatibility
      • Configuration
      • REST API
      • Web Applications
      • Process Applications
      • Spring Eventing Bridge
      • Developing and Testing
    • Quarkus Integration
      • Version Compatibility
      • Configuration
      • Engine CDI Integration
      • Resource Deployments
    • CDI and Java EE Integration
      • JTA Transaction Integration
      • Expression Resolving
      • Contextual Programming Model
      • Built-In Beans
      • CDI Event Bridge
    • Testing
      • Assert Examples
    • 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
      • DMN Model API
        • Read a Model
        • Create a Model
        • Repository Service
        • Extension Attributes
    • Data Formats (XML, JSON, Other)
      • Configuring Spin Integration
      • Data Formats in Processes
      • XML
      • JSON
    • User Task Forms
      • JSF Task Forms
    • DMN Engine
      • Embed
      • Evaluate Decisions
      • Expressions
      • FEEL Engine
        • Type Handling
        • Custom Functions
        • Spin Integration
        • Legacy Behavior
      • Data Types
      • Testing
    • Logging
    • Security Instructions
    • Camunda License Keys
    • External Task Client
      • Spring Boot Starter
      • Version Compatibility
    • Camunda Platform RPA Bridge
  • Reference
    • REST API
      • Overview
        • Configure Authentication
        • Usage with a Pre-Built Distribution
        • Embed the API
        • Hypertext Application Language (HAL)
        • Variables in the REST API
        • Date Format
      • OpenAPI
      • 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
        • Update history time to live
      • 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
      • Condition
        • Evaluate
      • Decision Definition
        • Get List
        • Get List Count
        • Get
        • Get XML
        • Get Diagram
        • Evaluate
        • Update history time to live
      • 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
        • Get Registered Deployments
      • Engine
        • Get List
      • Event Subscription
        • Get List
        • Get List Count
      • Execution
        • Local Variables
          • Get List
          • Get
          • Get (Binary)
          • Update
          • Post (Binary)
          • Modify
          • Delete
        • Message Event Subscription
          • Get
          • Trigger
        • Get List
        • Get List Count
        • Get
        • Create Incident
        • 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
        • Get Error Details
        • Get External Task Topic Names
        • Handle BPMN Error
        • Handle Failure
        • Lock
        • Extend Lock
        • Unlock
        • Set Priority
        • Set Retries
        • Set Retries Async
        • Set Retries Sync
      • 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
        • Get List (POST)
        • Get List Count (POST)
        • Create
        • Update
        • Options
        • Delete
      • Enhancement
        • Deployment
          • Create Deployment
        • Engine Info
          • Get ProcessEngine Info
        • Enhancement Filter
        • External Task Log
          • Get List
          • Get External Task Log List Count
          • Get
          • Count (POST)
          • List (POST)
        • Job Log
          • Get List
          • Get List Count
          • Get
          • Get List Count (POST)
          • Get List (POST)
        • Milestone
        • Open Process Definition
          • Get Process Definition
          • Start Instance
        • Open Task
          • Get Task
          • Submit Form
        • Process Definition
          • Get Process Definition Overview
          • Get Process Definition Statistics
        • Process Instance
          • Get Process Instance List
          • POST Process Instance List
      • History
        • Activity Instance
          • Get List
          • Get List Count
          • Get
          • Get List (POST)
          • Get List Count (POST)
        • Batch
          • Get List
          • Get List Count
          • Get
          • Delete
          • Get Cleanable Batch Report
          • Get Cleanable Batch Report Count
          • Set Removal Time Async (POST)
        • Case Definition
          • Get Historic Case Activity Statistics
          • Get Cleanable Case Instance Report
          • Get Cleanable Case Instance Report Count
        • 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 Definition
          • Get Cleanable Decision Instance Report
          • Get Cleanable Decision Instance Report Count
        • Decision Instance
          • Get List
          • Get List Count
          • Get
          • Set Removal Time Async (POST)
          • Delete Async (POST)
        • Decision Requirements Definition
          • Get Historic Decision Instance Statistics
        • Detail
          • Get List
          • Get List (POST)
          • Get List Count
          • Get
          • Get (Binary)
        • Identity link log
          • Get List
          • Get List Count
        • Incident
          • Get List
          • Get List Count
        • External Task Log
          • Get List
          • Get List Count
          • Get
          • Get Error Details
          • Get List Count (POST)
          • Get List (POST)
        • History Cleanup
          • Clean up history (POST)
          • Find clean up history jobs (GET)
          • Get History Cleanup Configuration
          • Find clean up history job (GET)
        • Job Log
          • Get List
          • Get List Count
          • Get
          • Get Stacktrace
          • Get List Count (POST)
          • Get List (POST)
        • Process Definition
          • Get Historic Activity Statistics
          • Get Cleanable Process Instance Report
          • Get Cleanable Process Instance Report Count
        • Process Instance
          • Get List
          • Get List Count
          • Get
          • Get List (POST)
          • Get List Count (POST)
          • Delete
          • Set Removal Time Async (POST)
          • Get Duration Report
          • Delete Async (POST)
          • Delete Variable Instances
        • Task
          • Get List
          • Get List Count
          • Get List (POST)
          • Get List Count (POST)
          • Get Task Report
        • User Operation Log
          • Get List
          • Get List Count
          • Set Annotation
          • Clear Annotation
        • Variable Instance
          • Get List
          • Get List Count
          • Get
          • Get (Binary)
          • Get List (POST)
          • Get List Count (POST)
          • Delete
      • Identity
        • Get Groups
        • Verify user
        • Get Password Policy
        • Validate Password
      • Incident
        • Get Incident
        • Get List
        • Get List Count
        • Resolve Incident
        • Set Incident Annotation
        • Clear Incident Annotation
      • Job
        • Get List
        • Get List Count
        • Get
        • Get List (POST)
        • Get List Count (POST)
        • Execute
        • Update Due Date
        • Recalculate 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
        • Delete Task Worker Metrics
      • Migration
        • Generate
        • Validate
        • Execute
        • Execute Async (Batch)
      • Modification
        • Execute Modification
        • Execute Modification Async (Batch)
      • Process Definition
        • Get Activity Instance Statistics
        • Get Static Called Process Definitions
        • 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
        • Update history time to live
        • Delete
        • Delete By Key
        • Get Deployed Start Form
        • Restart Process Instance
        • Restart Process Instance Async
      • Process Instance
        • Comment
          • Get List
        • Variables
          • Delete
          • Get (Binary)
          • Get
          • Get List
          • Post (Binary)
          • Modify
          • Update
        • Delete
        • Get Activity Instance
        • Get List Count
        • Get List
        • Get
        • Modify
        • Modify Async
        • 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)
        • Set Variables Async (POST)
        • Correlate Message Async (POST)
        • Get List (POST)
        • Activate/Suspend By Id
        • Activate/Suspend By Process Definition Id
        • Activate/Suspend By Process Definition Key
        • Activate/Suspend In Group
        • Activate/Suspend In Batch
      • Signal
        • Event
      • Schema Log
        • Get List
        • Get List (POST)
      • 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 Deployed Form
        • Get Rendered Form
        • Get Task Form Variables
        • Create
        • Update
        • Handle BPMN Error
        • Handle BPMN Escalation
        • Delete
      • Telemetry
        • Configure Telemetry
        • Fetch Telemetry Configuration
        • Get Telemetry Data
      • 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
        • Unlock User
      • Variable Instance
        • Get (Binary)
        • Get List Count
        • Get List
        • Get
        • Get List (POST)
        • Get List Count (POST)
      • Version
    • 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.3
      • Decision Table
        • Input
        • Output
        • Rule
        • Hit Policy
      • Decision Literal Expression
      • Decision Requirements Graph
      • FEEL
        • Legacy FEEL Reference
          • 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
      • Embedded Forms
        • Controls
          • Text Inputs
          • Textareas
          • Date Inputs
          • Boolean Inputs
          • Selects
          • Hidden Input Fields
          • File Upload and Download
          • BPMN Event Buttons
        • 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
      • Camunda Forms
    • 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
    • Database Schema
    • Remote Engine Distribution
    • Shared Engine Distribution
      • Tomcat
        • Pre-Packaged Distribution
        • Manual Installation
        • Configuration
      • JBoss EAP/Wildfly
        • Pre-Packaged Distribution
        • Manual Installation
        • Configuration
      • IBM WebSphere
        • Manual Installation: WebSphere 9
        • Manual Installation: WebSphere Liberty
        • Configuration
      • Oracle WebLogic
        • Manual Installation
        • Configuration
    • Docker
    • Standalone Webapplication (.war)
    • Spring Boot
    • Karaf / OSGi
    • Camunda Platform RPA Bridge
  • Modeler
    • BPMN
    • DMN
    • Forms
    • Element Templates
  • Web Applications
    • Admin
      • User Management
      • Group Management
      • Tenant Management
      • Authorization Management
      • System Management
      • Auditing
      • Configuration
      • Extending
        • Plugins
    • Cockpit
      • Dashboard
      • BPMN Processes
        • Dashboard
        • Process Definition View
        • Process Instance View
        • History
        • Instance Modification
        • Instance Restart
        • Instance Migration
        • Failed Jobs
        • Suspension
        • Correlate Message
        • Collapsed Subprocesses
      • 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
      • Cleanup
      • 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
    • Shared Configuration Options
      • Authentication
      • CSRF Prevention
      • Cookie Security
      • HTTP Header Security
  • Examples
  • Update & Migration
    • Minor Version Update
      • 7.17 to 7.18
        • Tomcat
        • WebLogic
        • WebSphere
        • Wildfly / JBoss EAP 7
      • 7.16 to 7.17
        • JBoss EAP 6 or Wildfly / JBoss EAP 7
        • Tomcat
        • WebLogic
        • WebSphere
      • 7.15 to 7.16
        • JBoss AS/Wildfly
        • Tomcat
        • WebLogic
        • WebSphere
      • 7.14 to 7.15
        • JBoss AS/Wildfly
        • Tomcat
        • WebLogic
        • WebSphere
      • 7.13 to 7.14
        • JBoss AS/Wildfly
        • Tomcat
        • WebLogic
        • WebSphere
      • 7.12 to 7.13
        • JBoss AS/Wildfly
        • Tomcat
        • WebLogic
        • WebSphere
      • 7.11 to 7.12
        • JBoss AS/Wildfly
        • Tomcat
        • WebLogic
        • WebSphere
      • 7.10 to 7.11
        • JBoss AS/Wildfly
        • Tomcat
        • WebLogic
        • WebSphere
      • 7.9 to 7.10
        • JBoss AS/Wildfly
        • Tomcat
        • WebLogic
        • WebSphere
      • 7.8 to 7.9
        • JBoss AS/Wildfly
        • Tomcat
        • WebLogic
        • WebSphere
      • 7.7 to 7.8
        • JBoss AS/Wildfly
        • Tomcat
        • WebLogic
        • WebSphere
      • 7.6 to 7.7
        • JBoss AS/Wildfly
        • Tomcat
        • Web Application Plugins
        • WebLogic
        • WebSphere
      • 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
    • Spring Boot Starter Migration and Update
      • 2.2.0 to 2.3.0
      • 2.3.0 to 3.0.0
      • 3.1.0 to 3.2.0
      • 3.3.0 to 3.4.0
      • 3.4.0 to 7.13.0
    • Migrating from Community to Enterprise Edition
    • Patch Level Update
    • Rolling Update
    • Activiti Migration

Options

Edit on Github

Metrics

Get Metrics in Interval
GET /metrics
Get Sum
GET /metrics/{metrics-name}/sum
Delete Task Worker Metrics
DELETE /metrics/task-worker

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 © 2024

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