Class Camunda8

constructor

• new Camunda8(config?): Camunda8

• All constructor parameters for configuration are optional. If no configuration is provided, the SDK will use environment variables to configure itself.

  Parameters

  • config: Camunda8ClientConfiguration = {}

  Returns Camunda8

log

getAdminApiClient

• getAdminApiClient(config?): AdminApiClient

• Returns a client for the Administration REST API See: https://docs.camunda.io/docs/apis-tools/administration-api/administration-api-reference/

  Parameters

  • config: Camunda8ClientConfiguration = {}

  Returns AdminApiClient

getCamundaRestClient

• getCamundaRestClient(config?): CamundaRestClient

• Returns a client for the Camunda 8 REST API See: https://docs.camunda.io/docs/apis-tools/camunda-api-rest/camunda-api-rest-overview/

  Parameters

  • config: Camunda8ClientConfiguration = {}

  Returns CamundaRestClient

getModelerApiClient

• getModelerApiClient(config?): ModelerApiClient

• Returns a client for the Web Modeler REST API See: https://docs.camunda.io/docs/apis-tools/web-modeler-api/overview/

  Parameters

  • config: Camunda8ClientConfiguration = {}

  Returns ModelerApiClient

getOperateApiClient

• getOperateApiClient(config?): OperateApiClient

• Returns a client for the "Operate REST API" See: https://docs.camunda.io/docs/apis-tools/operate-api/overview/

  Parameters

  • config: Camunda8ClientConfiguration = {}

  Returns OperateApiClient

getOptimizeApiClient

• getOptimizeApiClient(config?): OptimizeApiClient

• Returns a client for the Optimize REST API See: https://docs.camunda.io/docs/apis-tools/optimize-api/overview/

  Parameters

  • config: Camunda8ClientConfiguration = {}

  Returns OptimizeApiClient

getTasklistApiClient

• getTasklistApiClient(config?): TasklistApiClient

• Returns a client for the Tasklist REST API See: https://docs.camunda.io/docs/apis-tools/tasklist-api-rest/tasklist-api-rest-overview/

  Parameters

  • config: Camunda8ClientConfiguration = {}

  Returns TasklistApiClient

getZeebeGrpcApiClient

• getZeebeGrpcApiClient(config?): ZeebeGrpcClient

• Returns a client for the Zeebe gRPC API See: https://docs.camunda.io/docs/apis-tools/zeebe-api/overview/

  Parameters

  • config: Camunda8ClientConfiguration = {}

  Returns ZeebeGrpcClient

getZeebeRestClient

• getZeebeRestClient(config?): ZeebeRestClient

• Parameters

  • config: Camunda8ClientConfiguration = {}

  Returns ZeebeRestClient

  Deprecated

  from 8.6.0. Please use getCamundaRestClient() instead.