Pre-release
This release is a pre-release and may not be stable for production use.
Neops Workflow Engine Client
Neops workflow engine API documentation
This Python package is automatically generated by the OpenAPI Generator project:
- API version: develop
- Package version: 0.42.2-beta.3
- Generator version: 7.10.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
Requirements.
Python 3.8+
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 neops_workflow_engine_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 neops_workflow_engine_client
Tests
Execute pytest to run the tests.
Getting Started
Please follow the installation procedure and then run the following:
import neops_workflow_engine_client
from neops_workflow_engine_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 = neops_workflow_engine_client.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
async with neops_workflow_engine_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = neops_workflow_engine_client.AppApi(api_client)
try:
api_response = await api_instance.app_controller_get_hello()
print("The response of AppApi->app_controller_get_hello:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling AppApi->app_controller_get_hello: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to http://localhost
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AppApi | app_controller_get_hello | GET / | |
| BlackboardApi | blackboard_controller_add_job_log | POST /blackboard/job/log | Add job execution log |
| BlackboardApi | blackboard_controller_poll_job | POST /blackboard/job | Poll for available jobs |
| BlackboardApi | blackboard_controller_push_job_result | POST /blackboard/job/result | Submit job execution result |
| BlackboardApi | blackboard_controller_show_active_jobs | GET /blackboard/jobs/active | List active jobs |
| BlackboardApi | blackboard_controller_show_jobs | GET /blackboard/jobs | List jobs with optional status filter |
| FunctionBlockApi | function_blocks_controller_find_all | GET /function-blocks/registrations/list | List all registered function blocks |
| FunctionBlockApi | function_blocks_controller_find_one_fb | GET /function-blocks/{pkg}/{name}/{version} | Get a function block by ID |
| FunctionBlockApi | function_blocks_controller_find_one_fb_registration | GET /function-blocks/registrations/{pkg}/{name}/{version} | Get a function block registration by ID |
| FunctionBlockApi | function_blocks_controller_get_workers_for_function_block | GET /function-blocks/{pkg}/{name}/{version}/workers | Get workers for a function block |
| FunctionBlockApi | function_blocks_controller_register | POST /function-blocks/register | Register a function block |
| FunctionBlockApi | function_blocks_controller_soft_delete | DELETE /function-blocks/{pkg}/{name}/{version} | Soft-delete a function block by ID |
| HealthApi | health_controller_healthy | GET /health | Check service health status |
| LicenseApi | license_controller_get | GET /license | Return active license flavor, limits, live usage, and feature toggles |
| SchemaApi | schema_controller_get_schema | GET /schema | Get the RootWorkflow JSON Schema of the workflow engine |
| VersionApi | version_controller_check_compatibility | POST /version/compatibility | Check version compatibility |
| VersionApi | version_controller_get_version | GET /version | Get version of the service |
| WorkersApi | workers_controller_cleanup | POST /workers/cleanup | Manually trigger cleanup of stale workers (offline > cleanup threshold) |
| WorkersApi | workers_controller_cleanup_offline | POST /workers/cleanup-offline | Clean up all currently offline workers (immediate) |
| WorkersApi | workers_controller_find_all | GET /workers | List all registered workers |
| WorkersApi | workers_controller_find_one | GET /workers/{uuid} | Get a worker by UUID |
| WorkersApi | workers_controller_find_online | GET /workers/online | List online workers only |
| WorkersApi | workers_controller_get_function_blocks | GET /workers/{uuid}/function-blocks | Get function blocks for a worker |
| WorkersApi | workers_controller_get_jobs | GET /workers/{uuid}/jobs | Get jobs for a worker |
| WorkersApi | workers_controller_ping | POST /workers/{uuid}/ping | Worker heartbeat/ping (also reactivates unregistered workers) |
| WorkersApi | workers_controller_register | POST /workers/register | Register a new worker |
| WorkersApi | workers_controller_remove | DELETE /workers/{uuid} | Remove a worker (soft-delete) |
| WorkersApi | workers_controller_unregister | POST /workers/{uuid}/unregister | Unregister a worker (graceful shutdown) |
| WorkflowsApi | publish_workflow | POST /workflow-definition/publish | Publish a workflow definition |
| WorkflowsApi | restore_workflow_definition | POST /workflow-definition/{id}/restore | Restore a soft-deleted workflow definition by ID |
| WorkflowsApi | workflow_definition_controller_find_all | GET /workflow-definition | Retrieve all workflow definitions |
| WorkflowsApi | workflow_definition_controller_find_by_sem_ver_string | GET /workflow-definition/find-by-semver/{semver} | Retrieve the closest matching workflow definition for a semantic version string |
| WorkflowsApi | workflow_definition_controller_find_one | GET /workflow-definition/{id} | Retrieve a workflow definitions by ID |
| WorkflowsApi | workflow_definition_controller_soft_delete | DELETE /workflow-definition/{id} | Soft-delete a workflow definition by ID |
| WorkflowsApi | workflow_execution_controller_abort | DELETE /workflow-execution/{id} | Abort a running workflow execution |
| WorkflowsApi | workflow_execution_controller_execute | POST /workflow-execution | Add a workflow execution to the table |
| WorkflowsApi | workflow_execution_controller_find_all | GET /workflow-execution | Retrieve all workflow executions |
| WorkflowsApi | workflow_execution_controller_find_all_active | GET /workflow-execution/active | Retrieve all active workflow executions |
| WorkflowsApi | workflow_execution_controller_find_all_by_state | GET /workflow-execution/state/{state} | Retrieve all workflow executions by state |
| WorkflowsApi | workflow_execution_controller_find_one | GET /workflow-execution/id/{id} | Retrieve a specific workflow execution by ID |
Documentation For Models
- BaseEntityDto
- CronConfiguration
- CrontabConfiguration
- DbUpdateDto
- DeviceCheckTypeDto
- DeviceConfigTypeDto
- DeviceExecutionResultTypeDto
- DeviceExecutionTypeDto
- DeviceFactTypeDto
- DeviceGroupCheckTypeDto
- DeviceGroupFactTypeDto
- DeviceGroupTypeDto
- DeviceTypeDto
- EntityAcquireByElasticQuery
- EntityAcquireByExpansion
- EntityAcquireContext
- EntityAcquireReference
- EntityCreateDto
- EntityDeleteDto
- EntityPatchDto
- EntityPatchDtoValue
- ExecuteWorkflowDto
- FindingDto
- FindingTargetDto
- HealthResponse
- InterfaceTypeDto
- JmesCondition
- JobDefinitionDto
- JobExecutionContextDto
- JobExecutionResultDbUpdatesDto
- JobExecutionResultDbUpdatesDtoUpdatesInner
- JobExecutionResultDto
- JobLogDto
- JobPollDto
- JobResultDto
- JobResultDtoAcquiresInner
- JobShowResultDto
- LicenseFeaturesDto
- LicenseLimitsDto
- LicenseLimitsDtoMaxWorkflowDefinitions
- LicenseResponseDto
- ParametrizedFunctionBlock
- PlatformTypeDto
- PublishBadRequestDto
- PublishConflictDto
- PublishRejectedDto
- PublishResultDto
- PublishRetryWithDto
- PublishWorkflowDefinitionDto
- RegisterFunctionBlockDto
- RegisterWorkerDto
- RepeatConfiguration
- RetryConfiguration
- RoleDeviceGroupTypeDto
- RootWorkflow
- VersionCompatibilityRequestDto
- VersionCompatibilityResponseDto
- VersionResponseDto
- VersionableDto
- WorkerRegistrationResponseDto
- WorkerState
- WorkersControllerCleanup200Response
- WorkflowAsStep
- WorkflowAsStepStepsInner
- WorkflowConfig
- WorkflowEntryDto
- WorkflowExecutionParameters
- WorkflowExecutionStrategy
- WorkflowReference
- WorkflowReferenceAcquireInner
Documentation For Authorization
Authentication schemes defined for the API:
JWT
- Type: Bearer authentication (JWT)
Author
1 maintainer
Release files for neops_workflow_engine_client 0.42.2b3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| neops_workflow_engine_client-0.42.2b3.tar.gz | 68.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| neops_workflow_engine_client-0.42.2b3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 235.5 kB
Release files / neops_workflow_engine_client-0.42.2b3.tar.gz
| Download URL | neops_workflow_engine_client-0.42.2b3.tar.gz |
|---|---|
| Size | 68.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ebf109dc07ffaece4976159a991168cd302718d8640a76dc3a7794bdf7da67ee
|
|
BLAKE2b-256 checksum How to use checksums |
9fb25e9ec73b1f265068fae5799ee34d7ec13f4e3d590d6d346225dba3079857
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.5 CPython/3.14.7 Linux/6.8.0-134-generic
|
Release files / neops_workflow_engine_client-0.42.2b3-py3-none-any.whl
| Download URL | neops_workflow_engine_client-0.42.2b3-py3-none-any.whl |
|---|---|
| Size | 167.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b2f2b352ebea78d695fed9a8ada1e84f8c55221ed1f3082cf96efafef2eb21c5
|
|
BLAKE2b-256 checksum How to use checksums |
6cc8bb7ae554ae679c4b0349523180d5ab8e16671b05a4851611f30667d9a58c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.5 CPython/3.14.7 Linux/6.8.0-134-generic
|
