Skip to content

README.md

Latest commit

 

History

History
232 lines (226 loc) · 17.1 KB

README.md

File metadata and controls

232 lines (226 loc) · 17.1 KB
Raw

Documentation for API Endpoints

All URIs are relative to https://fbn-prd.lusid.com/workflow

Class Method HTTP request Description
ActionLogsApi get_action_logs GET /api/actionlogs/{id} GetActionLogs: Get the Action Logs for an Action Id
ApplicationMetadataApi list_access_controlled_resources GET /api/metadata/access/resources ListAccessControlledResources: Get resources available for access control
ApplicationMetadataApi list_api_endpoints GET /api/metadata/endpoints ListApiEndpoints: Get the API endpoints available
EventHandlersApi create_event_handler POST /api/eventhandlers CreateEventHandler: Create a new Event Handler
EventHandlersApi delete_event_handler DELETE /api/eventhandlers/{scope}/{code} DeleteEventHandler: Delete an Event Handler
EventHandlersApi get_event_handler GET /api/eventhandlers/{scope}/{code} GetEventHandler: Get an Event Handler
EventHandlersApi list_event_handlers GET /api/eventhandlers ListEventHandlers: List Event Handlers
EventHandlersApi update_event_handler PUT /api/eventhandlers/{scope}/{code} UpdateEventHandler: Update an existing Event handler
LaunchersApi create_launcher POST /api/workflows/{scope}/{code}/launchers [EXPERIMENTAL] CreateLauncher: Create a new Launcher on a Workflow
LaunchersApi delete_launcher DELETE /api/workflows/{scope}/{code}/launchers/{launcherId} [EXPERIMENTAL] DeleteLauncher: Delete a Launcher of a Workflow
LaunchersApi get_launcher GET /api/workflows/{scope}/{code}/launchers/{launcherId} [EXPERIMENTAL] GetLauncher: Get a Launcher of a Workflow
LaunchersApi list_launchers GET /api/workflows/{scope}/{code}/launchers [EXPERIMENTAL] ListLaunchers: List the Launchers of a Workflow
LaunchersApi update_launcher PUT /api/workflows/{scope}/{code}/launchers/{launcherId} [EXPERIMENTAL] UpdateLauncher: Update an existing Launcher of a Workflow
TaskDefinitionsApi create_task_definition POST /api/taskdefinitions CreateTaskDefinition: Create a new Task Definition
TaskDefinitionsApi delete_task_definition DELETE /api/taskdefinitions/{scope}/{code} DeleteTaskDefinition: Delete a Task Definition
TaskDefinitionsApi get_task_definition GET /api/taskdefinitions/{scope}/{code} GetTaskDefinition: Get a Task Definition
TaskDefinitionsApi list_task_definitions GET /api/taskdefinitions ListTaskDefinitions: List Task Definitions
TaskDefinitionsApi list_tasks_for_task_definition GET /api/taskdefinitions/{scope}/{code}/tasks ListTasksForTaskDefinition: List Tasks for a Task Definition
TaskDefinitionsApi update_task_definition PUT /api/taskdefinitions/{scope}/{code} UpdateTaskDefinition: Update an existing Task Definition
TaskDefinitionsApi upsert_task_definition_properties POST /api/taskdefinitions/{scope}/{code}/properties [EXPERIMENTAL] UpsertTaskDefinitionProperties: Add, update and remove properties on an existing Task Definition in bulk.
TasksApi batch_update_tasks PATCH /api/tasks/$update BatchUpdateTasks: Batch update tasks
TasksApi create_task POST /api/tasks CreateTask: Create a new Task
TasksApi delete_task DELETE /api/tasks/{id} DeleteTask: Delete a Task
TasksApi delete_tasks POST /api/tasks/$delete DeleteTasks: Batch Delete Tasks
TasksApi get_task GET /api/tasks/{id} GetTask: Get a Task
TasksApi get_task_history GET /api/tasks/{id}/history GetTaskHistory: Get the history of a Task
TasksApi list_tasks GET /api/tasks ListTasks: List Tasks
TasksApi update_task POST /api/tasks/{id} UpdateTask: Update a Task
WorkersApi create_worker POST /api/workers CreateWorker: Create a new Worker
WorkersApi delete_worker DELETE /api/workers/{scope}/{code} DeleteWorker: Delete a Worker
WorkersApi get_worker GET /api/workers/{scope}/{code} GetWorker: Get a Worker
WorkersApi get_worker_result GET /api/workers/{runId}/$result GetWorkerResult: Get the status of a specific run of a worker with any relevant results
WorkersApi list_workers GET /api/workers ListWorkers: List Workers
WorkersApi run_worker POST /api/workers/{scope}/{code}/$run RunWorker: Run a Worker
WorkersApi update_worker PUT /api/workers/{scope}/{code} UpdateWorker: Update a Worker
WorkflowsApi create_workflow POST /api/workflows CreateWorkflow: Create a new Workflow
WorkflowsApi delete_workflow DELETE /api/workflows/{scope}/{code} [EXPERIMENTAL] DeleteWorkflow: Delete a Workflow
WorkflowsApi get_workflow GET /api/workflows/{scope}/{code} GetWorkflow: Get a Workflow
WorkflowsApi list_workflows GET /api/workflows ListWorkflows: List Workflows
WorkflowsApi update_workflow PUT /api/workflows/{scope}/{code} [EXPERIMENTAL] UpdateWorkflow: Update an existing Workflow
WorkflowsApi upsert_workflow_properties POST /api/workflows/{scope}/{code}/properties [EXPERIMENTAL] UpsertWorkflowProperties: Add, update and remove properties on an existing Workflow in bulk.

Documentation for Models