Skip to content

dart

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

dart

README.md

nativebpm_client

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>

This Dart package is automatically generated by the OpenAPI Generator project:

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

Requirements

Dart 2.12 or later

Installation & Usage

Github

If this Dart package is published to Github, add the following dependency to your pubspec.yaml

dependencies:
  nativebpm_client:
    git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git

Local

To use the package in your local drive, add the following dependency to your pubspec.yaml

dependencies:
  nativebpm_client:
    path: /path/to/nativebpm_client

Tests

TODO

Getting Started

Please follow the installation procedure and then run the following:

import 'package:nativebpm_client/api.dart';


final api_instance = DefaultApi();
final id = id_example; // String | 
final claimTaskRequest = ClaimTaskRequest(); // ClaimTaskRequest | 

try {
    final result = api_instance.claimTask(id, claimTaskRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->claimTask: $e\n');
}

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.

Author