# lusid-workflow-sdk
FINBOURNE Technology
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 0.1.973
- Package version: 2.1.10
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://www.finbourne.com](https://www.finbourne.com)
## Requirements.
Python 3.7+
## Installation & Usage
### pip install
If the python package is hosted on a repository, you can install directly using:
```sh
pip install git+https://github.com/finbourne/workflow-sdk-python.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/finbourne/workflow-sdk-python.git`)
Then import the package:
```python
import lusid_workflow
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import lusid_workflow
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
You'll need to provide some configuration to connect to the lusid_workflow application.
These can be provided using a secrets file or environment variables.
### Environment variables
In order to use [short lived access tokens](https://support.lusid.com/knowledgebase/article/KA-01654/en-us) you will need to have appropriate values set for the following environment variables:
```
FBN_TOKEN_URL,
FBN_LUSID_WORKFLOW_API_URL,
FBN_USERNAME,
FBN_PASSWORD,
FBN_CLIENT_ID,
FBN_CLIENT_SECRET
```
To use a long lived Personal Access Token, you must provide the following environment variables:
```
FBN_LUSID_WORKFLOW_API_URL,
FBN_ACCESS_TOKEN
```
You can send your requests to lusid_workflow via a proxy, by setting `FBN_PROXY_ADDRESS`.
If your proxy has basic auth enabled, you must akso supply `FBN_PROXY_USERNAME` and `FBN_PROXY_PASSWORD`
### Secrets file
In order to use [short lived access tokens](https://support.lusid.com/knowledgebase/article/KA-01654/en-us) you will need to have appropriate values set in a `secrets.json` file in the same folder as your script.
```
{
"api":
{
"tokenUrl":"<your-token-url>",
"lusid_workflowUrl":"<FINBOURNE-application-url>",
"username":"<your-username>",
"password":"<your-password>",
"clientId":"<your-client-id>",
"clientSecret":"<your-client-secret>",
}
}
```
To use a long lived Personal Access Token, you must provide a `secrets.json` with the following variables:
```
{
"api":
{
"lusid_workflowUrl":"<FINBOURNE-application-url>",
"accessToken":"<your-access-token>"
}
}
```
You can send your requests to lusid_workflow via a proxy, by adding a proxy section to your `secrets.json`.
If your proxy has basic auth enabled, you must also supply a `username` and `password` in this section.
```
{
"api":
{
"lusid_workflowUrl":"<FINBOURNE-application-url>",
"accessToken":"<your-access-token>"
},
"proxy":
{
"address":"<your-proxy-address>",
"username":"<your-proxy-username>",
"password":"<your-proxy-password>"
}
}
```
### Using the SDK
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import time
import lusid_workflow
from lusid_workflow.exceptions import ApiException
from pprint import pprint
import os
from lusid_workflow import (
ApiClientFactory,
ApplicationMetadataApi,
EnvironmentVariablesConfigurationLoader,
SecretsFileConfigurationLoader,
ArgsConfigurationLoader
)
# Use the lusid_workflow ApiClientFactory to build Api instances with a configured api client
# By default this will read config from environment variables
# Then from a secrets.json file found in the current working directory
api_client_factory = ApiClientFactory()
# The ApiClientFactory can be passed an iterable of configuration loaders to read configuration from
api_url = "https://fbn-prd.lusid.com/workflow"
# Path to a secrets.json file containing authentication credentials
# See https://support.lusid.com/knowledgebase/article/KA-01667/en-us
# for a detailed guide to setting up the SDK make authenticated calls to LUSID APIs
secrets_path = os.getenv("FBN_SECRETS_PATH")
app_name="LusidJupyterNotebook"
config_loaders = [
EnvironmentVariablesConfigurationLoader(),
SecretsFileConfigurationLoader(api_secrets_file=secrets_path),
ArgsConfigurationLoader(api_url=api_url, app_name=app_name)
]
api_client_factory = ApiClientFactory(config_loaders=config_loaders)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Enter a context with an instance of the ApiClientFactory to ensure the connection pool is closed after use
async with api_client_factory:
# Create an instance of the API class
api_instance = api_client_factory.build(ApplicationMetadataApi)
try:
# [EXPERIMENTAL] ListAccessControlledResources: Get resources available for access control
api_response = await api_instance.list_access_controlled_resources()
print("The response of ApplicationMetadataApi->list_access_controlled_resources:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling ApplicationMetadataApi->list_access_controlled_resources: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://fbn-prd.lusid.com/workflow*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ApplicationMetadataApi* | [**list_access_controlled_resources**](docs/ApplicationMetadataApi.md#list_access_controlled_resources) | **GET** /api/metadata/access/resources | [EXPERIMENTAL] ListAccessControlledResources: Get resources available for access control
*TaskDefinitionsApi* | [**create_task_definition**](docs/TaskDefinitionsApi.md#create_task_definition) | **POST** /api/taskdefinitions | [EXPERIMENTAL] CreateTaskDefinition: Create a new Task Definition
*TaskDefinitionsApi* | [**delete_task_definition**](docs/TaskDefinitionsApi.md#delete_task_definition) | **DELETE** /api/taskdefinitions/{scope}/{code} | [EXPERIMENTAL] DeleteTaskDefinition: Delete a Task Definition
*TaskDefinitionsApi* | [**get_task_definition**](docs/TaskDefinitionsApi.md#get_task_definition) | **GET** /api/taskdefinitions/{scope}/{code} | [EXPERIMENTAL] GetTaskDefinition: Get a Task Definition
*TaskDefinitionsApi* | [**list_task_definitions**](docs/TaskDefinitionsApi.md#list_task_definitions) | **GET** /api/taskdefinitions | [EXPERIMENTAL] ListTaskDefinitions: List Task Definitions
*TaskDefinitionsApi* | [**list_tasks_for_task_definition**](docs/TaskDefinitionsApi.md#list_tasks_for_task_definition) | **GET** /api/taskdefinitions/{scope}/{code}/tasks | [EXPERIMENTAL] ListTasksForTaskDefinition: List Tasks for a Task Definition
*TaskDefinitionsApi* | [**update_task_definition**](docs/TaskDefinitionsApi.md#update_task_definition) | **PUT** /api/taskdefinitions/{scope}/{code} | [EXPERIMENTAL] UpdateTaskDefinition: Update an existing Task Definition
*TasksApi* | [**create_task**](docs/TasksApi.md#create_task) | **POST** /api/tasks | [EXPERIMENTAL] CreateTask: Create a new Task
*TasksApi* | [**delete_task**](docs/TasksApi.md#delete_task) | **DELETE** /api/tasks/{id} | [EXPERIMENTAL] DeleteTask: Delete a Task
*TasksApi* | [**get_task**](docs/TasksApi.md#get_task) | **GET** /api/tasks/{id} | [EXPERIMENTAL] GetTask: Get a Task
*TasksApi* | [**list_tasks**](docs/TasksApi.md#list_tasks) | **GET** /api/tasks | [EXPERIMENTAL] ListTasks: List Tasks
*TasksApi* | [**update_task**](docs/TasksApi.md#update_task) | **POST** /api/tasks/{id} | [EXPERIMENTAL] UpdateTask: Update a Task
*WorkersApi* | [**create_worker**](docs/WorkersApi.md#create_worker) | **POST** /api/workers | [EXPERIMENTAL] CreateWorker: Create a new Worker
*WorkersApi* | [**delete_worker**](docs/WorkersApi.md#delete_worker) | **DELETE** /api/workers/{scope}/{code} | [EXPERIMENTAL] DeleteWorker: Delete a Worker
*WorkersApi* | [**get_worker**](docs/WorkersApi.md#get_worker) | **GET** /api/workers/{scope}/{code} | [EXPERIMENTAL] GetWorker: Get a Worker
*WorkersApi* | [**get_worker_result**](docs/WorkersApi.md#get_worker_result) | **GET** /api/workers/{runId}/$result | [EXPERIMENTAL] GetWorkerResult: Get the status of a specific run of a worker with any relevant results
*WorkersApi* | [**list_workers**](docs/WorkersApi.md#list_workers) | **GET** /api/workers | [EXPERIMENTAL] ListWorkers: List Workers
*WorkersApi* | [**run_worker**](docs/WorkersApi.md#run_worker) | **POST** /api/workers/{scope}/{code}/$run | [EXPERIMENTAL] RunWorker: Run a Worker
*WorkersApi* | [**update_worker**](docs/WorkersApi.md#update_worker) | **PUT** /api/workers/{scope}/{code} | [EXPERIMENTAL] UpdateWorker: Update a Worker
## Documentation For Models
- [AccessControlledAction](docs/AccessControlledAction.md)
- [AccessControlledResource](docs/AccessControlledResource.md)
- [ActionDefinition](docs/ActionDefinition.md)
- [ActionDefinitionResponse](docs/ActionDefinitionResponse.md)
- [ActionDetails](docs/ActionDetails.md)
- [ActionDetailsResponse](docs/ActionDetailsResponse.md)
- [ActionId](docs/ActionId.md)
- [CreateChildTaskConfiguration](docs/CreateChildTaskConfiguration.md)
- [CreateChildTasksAction](docs/CreateChildTasksAction.md)
- [CreateChildTasksActionResponse](docs/CreateChildTasksActionResponse.md)
- [CreateTaskDefinitionRequest](docs/CreateTaskDefinitionRequest.md)
- [CreateTaskRequest](docs/CreateTaskRequest.md)
- [CreateWorkerRequest](docs/CreateWorkerRequest.md)
- [DeletedEntityResponse](docs/DeletedEntityResponse.md)
- [Fail](docs/Fail.md)
- [FailResponse](docs/FailResponse.md)
- [FieldMapping](docs/FieldMapping.md)
- [GetWorkerResultResponse](docs/GetWorkerResultResponse.md)
- [HealthCheck](docs/HealthCheck.md)
- [HealthCheckResponse](docs/HealthCheckResponse.md)
- [IdSelectorDefinition](docs/IdSelectorDefinition.md)
- [IdentifierPartSchema](docs/IdentifierPartSchema.md)
- [InitialState](docs/InitialState.md)
- [Link](docs/Link.md)
- [LuminesceView](docs/LuminesceView.md)
- [LuminesceViewResponse](docs/LuminesceViewResponse.md)
- [LusidProblemDetails](docs/LusidProblemDetails.md)
- [LusidValidationProblemDetails](docs/LusidValidationProblemDetails.md)
- [PagedResourceListOfTask](docs/PagedResourceListOfTask.md)
- [PagedResourceListOfTaskDefinition](docs/PagedResourceListOfTaskDefinition.md)
- [PagedResourceListOfWorker](docs/PagedResourceListOfWorker.md)
- [Parameter](docs/Parameter.md)
- [ParameterValue](docs/ParameterValue.md)
- [ResourceId](docs/ResourceId.md)
- [ResourceListOfAccessControlledResource](docs/ResourceListOfAccessControlledResource.md)
- [ResourceListOfTask](docs/ResourceListOfTask.md)
- [ResultField](docs/ResultField.md)
- [ResultMatchingPattern](docs/ResultMatchingPattern.md)
- [ResultantChildTaskConfiguration](docs/ResultantChildTaskConfiguration.md)
- [RunWorkerAction](docs/RunWorkerAction.md)
- [RunWorkerActionResponse](docs/RunWorkerActionResponse.md)
- [RunWorkerRequest](docs/RunWorkerRequest.md)
- [RunWorkerResponse](docs/RunWorkerResponse.md)
- [SchedulerJob](docs/SchedulerJob.md)
- [SchedulerJobResponse](docs/SchedulerJobResponse.md)
- [Sleep](docs/Sleep.md)
- [SleepResponse](docs/SleepResponse.md)
- [Stack](docs/Stack.md)
- [Task](docs/Task.md)
- [TaskDefinition](docs/TaskDefinition.md)
- [TaskDefinitionVersion](docs/TaskDefinitionVersion.md)
- [TaskFieldDefinition](docs/TaskFieldDefinition.md)
- [TaskInstanceField](docs/TaskInstanceField.md)
- [TaskStateDefinition](docs/TaskStateDefinition.md)
- [TaskSummary](docs/TaskSummary.md)
- [TaskTransitionDefinition](docs/TaskTransitionDefinition.md)
- [TransitionTriggerDefinition](docs/TransitionTriggerDefinition.md)
- [TriggerParentTaskAction](docs/TriggerParentTaskAction.md)
- [TriggerParentTaskActionResponse](docs/TriggerParentTaskActionResponse.md)
- [TriggerSchema](docs/TriggerSchema.md)
- [UpdateTaskDefinitionRequest](docs/UpdateTaskDefinitionRequest.md)
- [UpdateTaskRequest](docs/UpdateTaskRequest.md)
- [UpdateWorkerRequest](docs/UpdateWorkerRequest.md)
- [VersionInfo](docs/VersionInfo.md)
- [Worker](docs/Worker.md)
- [WorkerConfiguration](docs/WorkerConfiguration.md)
- [WorkerConfigurationResponse](docs/WorkerConfigurationResponse.md)
- [WorkerStatusTriggers](docs/WorkerStatusTriggers.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Authentication schemes defined for the API:
<a id="oauth2"></a>
### oauth2
- **Type**: OAuth
- **Flow**: implicit
- **Authorization URL**: https://lusid.okta.com/oauth2/default/v1/authorize
- **Scopes**: N/A
## Author
info@finbourne.com
Raw data
{
"_id": null,
"home_page": "https://github.com/finbourne/workflow-sdk-python",
"name": "lusid-workflow-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, FINBOURNE Workflow API, lusid-workflow-sdk",
"author": "FINBOURNE Technology",
"author_email": "info@finbourne.com",
"download_url": "https://files.pythonhosted.org/packages/56/e7/25fd79bc6d2606a40b66f7d33d0800788a489e967742676240e02d46d54c/lusid_workflow_sdk-2.1.10.tar.gz",
"platform": null,
"description": "# lusid-workflow-sdk\nFINBOURNE Technology\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 0.1.973\n- Package version: 2.1.10\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\nFor more information, please visit [https://www.finbourne.com](https://www.finbourne.com)\n\n## Requirements.\n\nPython 3.7+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/finbourne/workflow-sdk-python.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/finbourne/workflow-sdk-python.git`)\n\nThen import the package:\n```python\nimport lusid_workflow\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport lusid_workflow\n```\n\n### Tests\n\nExecute `pytest` to run the tests.\n\n## Getting Started\n\nYou'll need to provide some configuration to connect to the lusid_workflow application.\nThese can be provided using a secrets file or environment variables.\n\n### Environment variables\n\nIn order to use [short lived access tokens](https://support.lusid.com/knowledgebase/article/KA-01654/en-us) you will need to have appropriate values set for the following environment variables:\n\n``` \nFBN_TOKEN_URL,\nFBN_LUSID_WORKFLOW_API_URL,\nFBN_USERNAME,\nFBN_PASSWORD,\nFBN_CLIENT_ID,\nFBN_CLIENT_SECRET\n```\n\nTo use a long lived Personal Access Token, you must provide the following environment variables:\n``` \nFBN_LUSID_WORKFLOW_API_URL,\nFBN_ACCESS_TOKEN\n```\n\nYou can send your requests to lusid_workflow via a proxy, by setting `FBN_PROXY_ADDRESS`. \nIf your proxy has basic auth enabled, you must akso supply `FBN_PROXY_USERNAME` and `FBN_PROXY_PASSWORD`\n\n### Secrets file\n\nIn order to use [short lived access tokens](https://support.lusid.com/knowledgebase/article/KA-01654/en-us) you will need to have appropriate values set in a `secrets.json` file in the same folder as your script.\n\n``` \n{\n \"api\":\n {\n \"tokenUrl\":\"<your-token-url>\",\n \"lusid_workflowUrl\":\"<FINBOURNE-application-url>\",\n \"username\":\"<your-username>\",\n \"password\":\"<your-password>\",\n \"clientId\":\"<your-client-id>\",\n \"clientSecret\":\"<your-client-secret>\",\n }\n}\n```\n\nTo use a long lived Personal Access Token, you must provide a `secrets.json` with the following variables:\n``` \n{\n \"api\":\n {\n \"lusid_workflowUrl\":\"<FINBOURNE-application-url>\",\n \"accessToken\":\"<your-access-token>\"\n }\n}\n```\n\nYou can send your requests to lusid_workflow via a proxy, by adding a proxy section to your `secrets.json`. \nIf your proxy has basic auth enabled, you must also supply a `username` and `password` in this section.\n\n``` \n{\n \"api\":\n {\n \"lusid_workflowUrl\":\"<FINBOURNE-application-url>\",\n \"accessToken\":\"<your-access-token>\"\n },\n \"proxy\":\n {\n \"address\":\"<your-proxy-address>\",\n \"username\":\"<your-proxy-username>\",\n \"password\":\"<your-proxy-password>\"\n }\n}\n```\n\n### Using the SDK\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport time\nimport lusid_workflow\nfrom lusid_workflow.exceptions import ApiException\nfrom pprint import pprint\n\nimport os\nfrom lusid_workflow import (\n ApiClientFactory,\n ApplicationMetadataApi,\n EnvironmentVariablesConfigurationLoader,\n SecretsFileConfigurationLoader,\n ArgsConfigurationLoader\n)\n\n# Use the lusid_workflow ApiClientFactory to build Api instances with a configured api client\n# By default this will read config from environment variables\n# Then from a secrets.json file found in the current working directory\napi_client_factory = ApiClientFactory()\n\n# The ApiClientFactory can be passed an iterable of configuration loaders to read configuration from\n\napi_url = \"https://fbn-prd.lusid.com/workflow\"\n# Path to a secrets.json file containing authentication credentials\n# See https://support.lusid.com/knowledgebase/article/KA-01667/en-us\n# for a detailed guide to setting up the SDK make authenticated calls to LUSID APIs\nsecrets_path = os.getenv(\"FBN_SECRETS_PATH\")\napp_name=\"LusidJupyterNotebook\"\n\nconfig_loaders = [\n\tEnvironmentVariablesConfigurationLoader(),\n\tSecretsFileConfigurationLoader(api_secrets_file=secrets_path),\n\tArgsConfigurationLoader(api_url=api_url, app_name=app_name)\n]\napi_client_factory = ApiClientFactory(config_loaders=config_loaders)\n\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n\n\n\n# Enter a context with an instance of the ApiClientFactory to ensure the connection pool is closed after use\nasync with api_client_factory:\n # Create an instance of the API class\n api_instance = api_client_factory.build(ApplicationMetadataApi)\n\n try:\n # [EXPERIMENTAL] ListAccessControlledResources: Get resources available for access control\n api_response = await api_instance.list_access_controlled_resources()\n print(\"The response of ApplicationMetadataApi->list_access_controlled_resources:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling ApplicationMetadataApi->list_access_controlled_resources: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://fbn-prd.lusid.com/workflow*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*ApplicationMetadataApi* | [**list_access_controlled_resources**](docs/ApplicationMetadataApi.md#list_access_controlled_resources) | **GET** /api/metadata/access/resources | [EXPERIMENTAL] ListAccessControlledResources: Get resources available for access control\n*TaskDefinitionsApi* | [**create_task_definition**](docs/TaskDefinitionsApi.md#create_task_definition) | **POST** /api/taskdefinitions | [EXPERIMENTAL] CreateTaskDefinition: Create a new Task Definition\n*TaskDefinitionsApi* | [**delete_task_definition**](docs/TaskDefinitionsApi.md#delete_task_definition) | **DELETE** /api/taskdefinitions/{scope}/{code} | [EXPERIMENTAL] DeleteTaskDefinition: Delete a Task Definition\n*TaskDefinitionsApi* | [**get_task_definition**](docs/TaskDefinitionsApi.md#get_task_definition) | **GET** /api/taskdefinitions/{scope}/{code} | [EXPERIMENTAL] GetTaskDefinition: Get a Task Definition\n*TaskDefinitionsApi* | [**list_task_definitions**](docs/TaskDefinitionsApi.md#list_task_definitions) | **GET** /api/taskdefinitions | [EXPERIMENTAL] ListTaskDefinitions: List Task Definitions\n*TaskDefinitionsApi* | [**list_tasks_for_task_definition**](docs/TaskDefinitionsApi.md#list_tasks_for_task_definition) | **GET** /api/taskdefinitions/{scope}/{code}/tasks | [EXPERIMENTAL] ListTasksForTaskDefinition: List Tasks for a Task Definition\n*TaskDefinitionsApi* | [**update_task_definition**](docs/TaskDefinitionsApi.md#update_task_definition) | **PUT** /api/taskdefinitions/{scope}/{code} | [EXPERIMENTAL] UpdateTaskDefinition: Update an existing Task Definition\n*TasksApi* | [**create_task**](docs/TasksApi.md#create_task) | **POST** /api/tasks | [EXPERIMENTAL] CreateTask: Create a new Task\n*TasksApi* | [**delete_task**](docs/TasksApi.md#delete_task) | **DELETE** /api/tasks/{id} | [EXPERIMENTAL] DeleteTask: Delete a Task\n*TasksApi* | [**get_task**](docs/TasksApi.md#get_task) | **GET** /api/tasks/{id} | [EXPERIMENTAL] GetTask: Get a Task\n*TasksApi* | [**list_tasks**](docs/TasksApi.md#list_tasks) | **GET** /api/tasks | [EXPERIMENTAL] ListTasks: List Tasks\n*TasksApi* | [**update_task**](docs/TasksApi.md#update_task) | **POST** /api/tasks/{id} | [EXPERIMENTAL] UpdateTask: Update a Task\n*WorkersApi* | [**create_worker**](docs/WorkersApi.md#create_worker) | **POST** /api/workers | [EXPERIMENTAL] CreateWorker: Create a new Worker\n*WorkersApi* | [**delete_worker**](docs/WorkersApi.md#delete_worker) | **DELETE** /api/workers/{scope}/{code} | [EXPERIMENTAL] DeleteWorker: Delete a Worker\n*WorkersApi* | [**get_worker**](docs/WorkersApi.md#get_worker) | **GET** /api/workers/{scope}/{code} | [EXPERIMENTAL] GetWorker: Get a Worker\n*WorkersApi* | [**get_worker_result**](docs/WorkersApi.md#get_worker_result) | **GET** /api/workers/{runId}/$result | [EXPERIMENTAL] GetWorkerResult: Get the status of a specific run of a worker with any relevant results\n*WorkersApi* | [**list_workers**](docs/WorkersApi.md#list_workers) | **GET** /api/workers | [EXPERIMENTAL] ListWorkers: List Workers\n*WorkersApi* | [**run_worker**](docs/WorkersApi.md#run_worker) | **POST** /api/workers/{scope}/{code}/$run | [EXPERIMENTAL] RunWorker: Run a Worker\n*WorkersApi* | [**update_worker**](docs/WorkersApi.md#update_worker) | **PUT** /api/workers/{scope}/{code} | [EXPERIMENTAL] UpdateWorker: Update a Worker\n\n\n## Documentation For Models\n\n - [AccessControlledAction](docs/AccessControlledAction.md)\n - [AccessControlledResource](docs/AccessControlledResource.md)\n - [ActionDefinition](docs/ActionDefinition.md)\n - [ActionDefinitionResponse](docs/ActionDefinitionResponse.md)\n - [ActionDetails](docs/ActionDetails.md)\n - [ActionDetailsResponse](docs/ActionDetailsResponse.md)\n - [ActionId](docs/ActionId.md)\n - [CreateChildTaskConfiguration](docs/CreateChildTaskConfiguration.md)\n - [CreateChildTasksAction](docs/CreateChildTasksAction.md)\n - [CreateChildTasksActionResponse](docs/CreateChildTasksActionResponse.md)\n - [CreateTaskDefinitionRequest](docs/CreateTaskDefinitionRequest.md)\n - [CreateTaskRequest](docs/CreateTaskRequest.md)\n - [CreateWorkerRequest](docs/CreateWorkerRequest.md)\n - [DeletedEntityResponse](docs/DeletedEntityResponse.md)\n - [Fail](docs/Fail.md)\n - [FailResponse](docs/FailResponse.md)\n - [FieldMapping](docs/FieldMapping.md)\n - [GetWorkerResultResponse](docs/GetWorkerResultResponse.md)\n - [HealthCheck](docs/HealthCheck.md)\n - [HealthCheckResponse](docs/HealthCheckResponse.md)\n - [IdSelectorDefinition](docs/IdSelectorDefinition.md)\n - [IdentifierPartSchema](docs/IdentifierPartSchema.md)\n - [InitialState](docs/InitialState.md)\n - [Link](docs/Link.md)\n - [LuminesceView](docs/LuminesceView.md)\n - [LuminesceViewResponse](docs/LuminesceViewResponse.md)\n - [LusidProblemDetails](docs/LusidProblemDetails.md)\n - [LusidValidationProblemDetails](docs/LusidValidationProblemDetails.md)\n - [PagedResourceListOfTask](docs/PagedResourceListOfTask.md)\n - [PagedResourceListOfTaskDefinition](docs/PagedResourceListOfTaskDefinition.md)\n - [PagedResourceListOfWorker](docs/PagedResourceListOfWorker.md)\n - [Parameter](docs/Parameter.md)\n - [ParameterValue](docs/ParameterValue.md)\n - [ResourceId](docs/ResourceId.md)\n - [ResourceListOfAccessControlledResource](docs/ResourceListOfAccessControlledResource.md)\n - [ResourceListOfTask](docs/ResourceListOfTask.md)\n - [ResultField](docs/ResultField.md)\n - [ResultMatchingPattern](docs/ResultMatchingPattern.md)\n - [ResultantChildTaskConfiguration](docs/ResultantChildTaskConfiguration.md)\n - [RunWorkerAction](docs/RunWorkerAction.md)\n - [RunWorkerActionResponse](docs/RunWorkerActionResponse.md)\n - [RunWorkerRequest](docs/RunWorkerRequest.md)\n - [RunWorkerResponse](docs/RunWorkerResponse.md)\n - [SchedulerJob](docs/SchedulerJob.md)\n - [SchedulerJobResponse](docs/SchedulerJobResponse.md)\n - [Sleep](docs/Sleep.md)\n - [SleepResponse](docs/SleepResponse.md)\n - [Stack](docs/Stack.md)\n - [Task](docs/Task.md)\n - [TaskDefinition](docs/TaskDefinition.md)\n - [TaskDefinitionVersion](docs/TaskDefinitionVersion.md)\n - [TaskFieldDefinition](docs/TaskFieldDefinition.md)\n - [TaskInstanceField](docs/TaskInstanceField.md)\n - [TaskStateDefinition](docs/TaskStateDefinition.md)\n - [TaskSummary](docs/TaskSummary.md)\n - [TaskTransitionDefinition](docs/TaskTransitionDefinition.md)\n - [TransitionTriggerDefinition](docs/TransitionTriggerDefinition.md)\n - [TriggerParentTaskAction](docs/TriggerParentTaskAction.md)\n - [TriggerParentTaskActionResponse](docs/TriggerParentTaskActionResponse.md)\n - [TriggerSchema](docs/TriggerSchema.md)\n - [UpdateTaskDefinitionRequest](docs/UpdateTaskDefinitionRequest.md)\n - [UpdateTaskRequest](docs/UpdateTaskRequest.md)\n - [UpdateWorkerRequest](docs/UpdateWorkerRequest.md)\n - [VersionInfo](docs/VersionInfo.md)\n - [Worker](docs/Worker.md)\n - [WorkerConfiguration](docs/WorkerConfiguration.md)\n - [WorkerConfigurationResponse](docs/WorkerConfigurationResponse.md)\n - [WorkerStatusTriggers](docs/WorkerStatusTriggers.md)\n\n\n<a id=\"documentation-for-authorization\"></a>\n## Documentation For Authorization\n\n\nAuthentication schemes defined for the API:\n<a id=\"oauth2\"></a>\n### oauth2\n\n- **Type**: OAuth\n- **Flow**: implicit\n- **Authorization URL**: https://lusid.okta.com/oauth2/default/v1/authorize\n- **Scopes**: N/A\n\n\n## Author\n\ninfo@finbourne.com\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "FINBOURNE Workflow API",
"version": "2.1.10",
"project_urls": {
"Homepage": "https://github.com/finbourne/workflow-sdk-python",
"Repository": "https://github.com/finbourne/workflow-sdk-python"
},
"split_keywords": [
"openapi",
" openapi-generator",
" finbourne workflow api",
" lusid-workflow-sdk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "96b06ee2eb4cbbb8d2eb350d65647e56360ac7f65d5e8fb2822c061b6f24cf4c",
"md5": "ae23351c2c1b0286aee1e4527bf1e038",
"sha256": "8eed148cf9a0256f2c004f445a729c291e90b1a387c3316aac6798d12e6336d4"
},
"downloads": -1,
"filename": "lusid_workflow_sdk-2.1.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ae23351c2c1b0286aee1e4527bf1e038",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 156450,
"upload_time": "2024-05-03T08:33:27",
"upload_time_iso_8601": "2024-05-03T08:33:27.739399Z",
"url": "https://files.pythonhosted.org/packages/96/b0/6ee2eb4cbbb8d2eb350d65647e56360ac7f65d5e8fb2822c061b6f24cf4c/lusid_workflow_sdk-2.1.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "56e725fd79bc6d2606a40b66f7d33d0800788a489e967742676240e02d46d54c",
"md5": "7128285ec5787b47e3053ba9c3d51c6c",
"sha256": "2ca83e676d80a218ac78bf4e4cef47305e685fdb8fcecfc3ce55b9e0013f7e97"
},
"downloads": -1,
"filename": "lusid_workflow_sdk-2.1.10.tar.gz",
"has_sig": false,
"md5_digest": "7128285ec5787b47e3053ba9c3d51c6c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 74659,
"upload_time": "2024-05-03T08:33:32",
"upload_time_iso_8601": "2024-05-03T08:33:32.385664Z",
"url": "https://files.pythonhosted.org/packages/56/e7/25fd79bc6d2606a40b66f7d33d0800788a489e967742676240e02d46d54c/lusid_workflow_sdk-2.1.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-03 08:33:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "finbourne",
"github_project": "workflow-sdk-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "lusid-workflow-sdk"
}
JSON
