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.2
- 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 | workflow_definition_controller_create | POST /workflow-definition | Create a Workflow definition |
| 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_definition_controller_update_workflow | POST /workflow-definition/update | Update a Workflow definition |
| 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
- CreateWorkflowDefinitionDto
- CronConfiguration
- CrontabConfiguration
- DbUpdateDto
- DeviceCheckTypeDto
- DeviceConfigTypeDto
- DeviceExecutionResultTypeDto
- DeviceExecutionTypeDto
- DeviceFactTypeDto
- DeviceGroupCheckTypeDto
- DeviceGroupFactTypeDto
- DeviceGroupTypeDto
- DeviceTypeDto
- EntityAcquireByElasticQuery
- EntityAcquireByExpansion
- EntityAcquireContext
- EntityAcquireReference
- EntityCreateDto
- EntityDeleteDto
- EntityPatchDto
- EntityPatchDtoValue
- EntityPatchDtoValueOneOfInner
- ExecuteWorkflowDto
- HealthResponse
- InterfaceTypeDto
- JobDefinitionDto
- JobExecutionContextDto
- JobExecutionResultDbUpdatesDto
- JobExecutionResultDbUpdatesDtoUpdatesInner
- JobExecutionResultDto
- JobLogDto
- JobPollDto
- JobResultDto
- JobResultDtoAcquiresInner
- JobShowResultDto
- LicenseFeaturesDto
- LicenseLimitsDto
- LicenseLimitsDtoMaxWorkflowDefinitions
- LicenseResponseDto
- ParametrizedFunctionBlock
- PlatformTypeDto
- RegisterFunctionBlockDto
- RegisterWorkerDto
- RepeatConfiguration
- RetryConfiguration
- RoleDeviceGroupTypeDto
- RootWorkflow
- UpdateWorkflowDefinitionDto
- VersionCompatibilityRequestDto
- VersionCompatibilityResponseDto
- VersionResponseDto
- VersionableDto
- WorkerRegistrationResponseDto
- WorkerState
- WorkersControllerCleanup200Response
- WorkflowAsStep
- WorkflowAsStepStepsInner
- WorkflowConfig
- WorkflowEntryDto
- WorkflowExecutionParameters
- WorkflowExecutionStrategy
- WorkflowReference
- WorkflowReferenceAcquireInner
- WorkflowReferenceAssertInner
Documentation For Authorization
Authentication schemes defined for the API:
JWT
- Type: Bearer authentication (JWT)
Author
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file neops_workflow_engine_client-0.42.2b2.tar.gz.
File metadata
- Download URL: neops_workflow_engine_client-0.42.2b2.tar.gz
- Upload date:
- Size: 63.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.5 CPython/3.14.6 Linux/6.8.0-134-generic
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2df63c9ff9639fec47d4977bfdc97074c52faefb6a81d69e586ba17d92ad895f
|
|
| MD5 |
c3782837d03b8cba17ad20b566533560
|
|
| BLAKE2b-256 |
6287102d0e4ed0d4d8446ecc094c72079d05a2075dbbac9b40de7bf0d8835a4f
|
File details
Details for the file neops_workflow_engine_client-0.42.2b2-py3-none-any.whl.
File metadata
- Download URL: neops_workflow_engine_client-0.42.2b2-py3-none-any.whl
- Upload date:
- Size: 155.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.5 CPython/3.14.6 Linux/6.8.0-134-generic
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
66f3b17f3202732c4d34b6551a97a2c12dd586458f78a28921bfc794ed337284
|
|
| MD5 |
cf33bd857f875122bf5aa38b9bfd0c43
|
|
| BLAKE2b-256 |
0a2779e548818b7565837f9a47e3e5978c201965182a87e075967dd42caf23d5
|
