Qodex.ai

Operate Public API (Self-Managed)

Number of APIs: 19

💪 What do you need to make it work?

Authentication for Self-Managed cluster​

Authentication via Identity JWT access token​

This authentication method is described in Operate Configuration - Authentication.

Authentication via cookie​

Another way to access the Operate API in a Self-Managed cluster is to send cookie headers in each request. The cookie can be obtained by using the API endpoint /api/login. Take the steps in the following example:

Example:

  1. Log in as user 'demo' and store the cookie in the file cookie.txt.
curl -c cookie.txt -X POST 'http://localhost:8080/api/login?username=demo&password=demo'
  1. Send the cookie (as a header) in each API request. In this case, request all process definitions.
curl -b cookie.txt -X POST 'http://localhost:8080/v1/process-definitions/search' -H 'Content-Type: app

Set variables

  1. baseUrlOperateLocal: URL of your Self-Managed deployment. Default is localhost:8081. If this doesn't work, check your ports mapping and define it in the global or environment scope.

  2. apiVersion: Currently supported and default is v1 - define this in the global or environment scope.

  3. username and password: Change it if different than demo/demo in collection variables.

Your Operate API is now up and running in Self-Managed mode, and you can execute API requests.

  1. Process definitions - Get process definition by key GET {{baseUrl+ApiVersion}}/process-definitions/:key

  2. Process definitions - Search for process definitions POST {{baseUrl+ApiVersion}}/process-definitions/search

  3. Process definitions - Get process defintion by key as XML GET {{baseUrl+ApiVersion}}/process-definitions/:key/xml

  4. Process instances - Search for process instances POST {{baseUrl+ApiVersion}}/process-instances/search

  5. Process instances - Get process instance by key GET {{baseUrl+ApiVersion}}/process-instances/:key

  6. Variables - Search for variables POST {{baseUrl+ApiVersion}}/variables/search

  7. Process instances - Delete process instance and dependant data by key DELETE {{baseUrl+ApiVersion}}/process-instances/:key

  8. Incidents - Search for incidents POST {{baseUrl+ApiVersion}}/incidents/search

  9. Incidents - Get incident by key GET {{baseUrl+ApiVersion}}/incidents/:key

  10. Flow node instances - Search for flow node instances POST {{baseUrl+ApiVersion}}/flownode-instances/search