Skip to content

README.md

Latest commit

 

History

History
143 lines (102 loc) · 5.88 KB

README.md

File metadata and controls

143 lines (102 loc) · 5.88 KB

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 Python package is automatically generated by the OpenAPI Generator project:

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

Requirements.

Python 3.10+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import nativebpm_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import nativebpm_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import nativebpm_client
from nativebpm_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = nativebpm_client.Configuration(
    host = "http://localhost"
)



# Enter a context with an instance of the API client
with nativebpm_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = nativebpm_client.DefaultApi(api_client)
    id = 'id_example' # str | 
    claim_task_request = nativebpm_client.ClaimTaskRequest() # ClaimTaskRequest | 

    try:
        # Claim human task
        api_response = api_instance.claim_task(id, claim_task_request)
        print("The response of DefaultApi->claim_task:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DefaultApi->claim_task: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
DefaultApi claim_task POST /api/tasks/{id}/claim Claim human task
DefaultApi complete_instance_task POST /api/instances/{id}/complete Complete a wait state / task activity in process instance
DefaultApi complete_task POST /api/tasks/{id}/complete Complete human task
DefaultApi create_webhook POST /api/webhooks Create webhook target
DefaultApi delete_webhook DELETE /api/webhooks/{id} Delete webhook target
DefaultApi deploy_definition POST /api/deploy Deploy process definition
DefaultApi get_instance GET /api/instances/{id} Get process instance
DefaultApi get_instance_history GET /api/instances/{id}/history Get process instance execution history
DefaultApi list_definitions GET /api/definitions List process definitions
DefaultApi list_incidents GET /api/instances/{id}/incidents List incidents for process instance
DefaultApi list_instances GET /api/instances List process instances
DefaultApi list_tasks GET /api/tasks List human/user tasks
DefaultApi list_webhook_deliveries GET /api/webhooks/{id}/deliveries List deliveries for webhook
DefaultApi list_webhooks GET /api/webhooks List configured outgoing webhooks
DefaultApi resolve_incident POST /api/instances/{id}/incidents/{incidentId}/resolve Resolve process incident
DefaultApi resume_instance POST /api/instances/{id}/resume Resume process instance
DefaultApi start_instance POST /api/definitions/{id}/start Start process instance
DefaultApi test_webhook POST /api/webhooks/{id}/test Test webhook target
DefaultApi update_webhook PUT /api/webhooks/{id} Update webhook target

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author