Qodex.ai

API documentation reference

Number of APIs: 9

🚀 Overview

Camunda maintains a set of collections and APIs on Qodex to help learn and use the available APIs.

Watch and fork your favorite collections and APIs here on the [Camunda Team]

🔖 Available Qodex APIs

  • Administration API (REST)

    • Create and manage clusters, and interact with Camunda 8 programmatically without using the Camunda 8 Console.

  • Administration API (Self-Managed)

    • The Administration API for Self-Managed is a REST API and provides endpoints to get cluster data including installed apps and usage metrics.

  • Camunda 8 API (REST)

    • The Camunda 8 REST API is a REST API designed to interact with a Camunda 8 cluster.

  • Operate API (REST)

    • Operate API is a REST API and provides searching, getting, and changing Operate data. Requests and responses are in JSON.

  • Optimize Public API (REST)

    • Connect business process-related event data and variable data held in external systems from third-party systems to Optimize

  • Tasklist API (GraphQL)

    • Build apps powered by BPMN that require human interaction, and make requests.

  • Tasklist API (REST)

    • Tasklist API is a REST API and provides searching, getting, and changing Tasklist data.

  • Web Modeler API (REST)

    • Web Modeler API is a REST API and provides access to Web Modeler data. Requests and responses are in JSON notation.

  • Zeebe API (gRPC)

    • Communicate with the cluster, activate jobs, cancel and create process instances, and more.

  • Zeebe API (REST)

    • The Zeebe REST API is a REST API designed to interact with the Zeebe process automation engine.

ℹ️ Notes

Collections and APIs are manually updated and not all API functionality may be available. For the most up-to-date API functionality, refer to the API reference docs.

  1. REST API basics - Delete data DELETE {{base_url}}/info?id=1

  2. REST API basics - Get data GET {{base_url}}/info?id=1

  3. REST API basics - Post data POST {{base_url}}/info

  4. REST API basics - Update data PUT {{base_url}}/info?id=1

  5. Example usage - Create a collection POST https://api.getpostman.com/collections

  6. Example usage - Get a collection GET https://api.getpostman.com/collections/{{collectionId}}

  7. Example usage - Get all collections GET https://api.getpostman.com/collections

  8. Example usage - Delete a collection DELETE https://api.getpostman.com/collections/{{collectionId}}

  9. Example usage - Update a collection PUT https://api.getpostman.com/collections/{{collectionId}}