Skip to content

kotlin

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

kotlin

README.md

com.nativebpm.client - Kotlin client library for NativeBPM Engine REST API

REST API for managing, executing, and monitoring workflows, human tasks, incidents, and outgoing webhooks inside the NativeBPM Cloud-Native engine.

Authentication

Requests must include a session cookie or a Bearer API token: Authorization: Bearer <API_TOKEN>

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

  • API version: 1.0.0
  • Package version:
  • Generator version: 7.24.0-SNAPSHOT
  • Build package: org.openapitools.codegen.languages.KotlinClientCodegen

Requires

  • Kotlin 2.2.20
  • Gradle 8.14

Build

First, create the gradle wrapper script:

gradle wrapper

Then, run:

./gradlew check assemble

This runs all tests and packages the library.

Features/Implementation Notes

  • Supports JSON inputs/outputs, File inputs, and Form inputs.
  • Supports collection formats for query parameters: csv, tsv, ssv, pipes.
  • Some Kotlin and Java types are fully qualified to avoid conflicts with types defined in OpenAPI definitions.
  • Implementation of ApiClient is intended to reduce method counts, specifically to benefit Android targets.

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
DefaultApi claimTask POST /api/tasks/{id}/claim Claim human task
DefaultApi completeInstanceTask POST /api/instances/{id}/complete Complete a wait state / task activity in process instance
DefaultApi completeTask POST /api/tasks/{id}/complete Complete human task
DefaultApi createWebhook POST /api/webhooks Create webhook target
DefaultApi deleteWebhook DELETE /api/webhooks/{id} Delete webhook target
DefaultApi deployDefinition POST /api/deploy Deploy process definition
DefaultApi getInstance GET /api/instances/{id} Get process instance
DefaultApi getInstanceHistory GET /api/instances/{id}/history Get process instance execution history
DefaultApi getInstanceVisualization GET /api/instances/{id}/visualization Get process instance visualization data
DefaultApi getInstanceVisualizationWidget GET /api/instances/{id}/visualization/widget Get process instance visualization widget HTML
DefaultApi getSMTPConfig GET /api/smtp-config Get SMTP configuration
DefaultApi getUserGroups GET /api/users/{username}/groups Get user groups
DefaultApi listDefinitions GET /api/definitions List process definitions
DefaultApi listIncidents GET /api/instances/{id}/incidents List incidents for process instance
DefaultApi listInstances GET /api/instances List process instances
DefaultApi listTasks GET /api/tasks List human/user tasks
DefaultApi listWebhookDeliveries GET /api/webhooks/{id}/deliveries List deliveries for webhook
DefaultApi listWebhooks GET /api/webhooks List configured outgoing webhooks
DefaultApi resolveIncident POST /api/instances/{id}/incidents/{incidentId}/resolve Resolve process incident
DefaultApi resumeInstance POST /api/instances/{id}/resume Resume process instance
DefaultApi startInstance POST /api/definitions/{id}/start Start process instance
DefaultApi testWebhook POST /api/webhooks/{id}/test Test webhook target
DefaultApi updateWebhook PUT /api/webhooks/{id} Update webhook target

Documentation for Models

Documentation for Authorization

Endpoints do not require authorization.