FINBOURNE Scheduler API
Project description
Documentation for API Endpoints
All URIs are relative to https://fbn-prd.lusid.com/scheduler2
| Class | Method | HTTP request | Description |
|---|---|---|---|
| ApplicationMetadataApi | list_access_controlled_resources | GET /api/metadata/access/resources | ListAccessControlledResources: Get resources available for access control |
| ImagesApi | get_image | GET /api/images/{name} | GetImage: Get metadata of a Docker Image |
| ImagesApi | list_images | GET /api/images/repository/{name} | ListImages: List all images under same image repository |
| ImagesApi | list_repositories | GET /api/images/repository | ListRepositories: List all Docker image repositories |
| ImagesApi | upload_image | POST /api/images | UploadImage: Upload a Docker Image used for Scheduler jobs |
| JobsApi | create_job | POST /api/jobs | CreateJob: Create a new job |
| JobsApi | delete_job | DELETE /api/jobs/{scope}/{code} | DeleteJob: Delete a job |
| JobsApi | get_history | GET /api/jobs/history | GetHistory: Get the history of job runs |
| JobsApi | get_job_console_output | GET /api/jobs/history/{runId}/console | GetJobConsoleOutput: Gets the console output of a specific job run |
| JobsApi | get_run_history | GET /api/jobs/history/{runId} | GetRunHistory: Get the history for a single job run |
| JobsApi | get_schedules_for_a_job | GET /api/jobs/{scope}/{code}/schedules | GetSchedulesForAJob: Get all the schedules for a single job |
| JobsApi | list_jobs | GET /api/jobs | ListJobs: List the available jobs |
| JobsApi | run_job | POST /api/jobs/{scope}/{code}/$run | RunJob: Run a job immediately |
| JobsApi | update_job | PUT /api/jobs/{scope}/{code} | UpdateJob: Update a JobDefinition |
| SchedulesApi | create_schedule | POST /api/schedules | CreateSchedule: Create a Schedule for a job |
| SchedulesApi | delete_schedule | DELETE /api/schedules/{scope}/{code} | DeleteSchedule: Delete a schedule |
| SchedulesApi | enabled_schedule | PUT /api/schedules/{scope}/{code}/enabled | EnabledSchedule: Enable/disable a schedule |
| SchedulesApi | get_schedule | GET /api/schedules/{scope}/{code} | GetSchedule: Get a single Schedule |
| SchedulesApi | get_valid_timezones | GET /api/schedules/timezones | GetValidTimezones: Get a list of valid timezones |
| SchedulesApi | list_schedules | GET /api/schedules | ListSchedules: List the available Schedules |
| SchedulesApi | run_schedule | POST /api/schedules/{scope}/{code}/$run | RunSchedule: Run a schedule immediately |
| SchedulesApi | update_schedule | PUT /api/schedules/{scope}/{code} | UpdateSchedule: Update a schedule. |
Documentation for Models
- AccessControlledAction
- AccessControlledResource
- ActionId
- ArgumentDefinition
- CreateJobRequest
- CreateScheduleRequest
- IdSelectorDefinition
- IdentifierPartSchema
- Image
- ImageSummary
- JobDefinition
- JobHistory
- JobRunResult
- Link
- LusidProblemDetails
- LusidValidationProblemDetails
- Notification
- Repository
- RequiredResources
- ResourceId
- ResourceListOfAccessControlledResource
- ResourceListOfImageSummary
- ResourceListOfJobDefinition
- ResourceListOfJobHistory
- ResourceListOfRepository
- ResourceListOfScheduleDefinition
- ResourceListOfString
- ScanReport
- ScanSummary
- ScheduleDefinition
- StartJobRequest
- StartJobResponse
- StartScheduleResponse
- Tag
- TimeTrigger
- Trigger
- UpdateJobRequest
- UpdateScheduleRequest
- UploadImageInstructions
- UploadImageRequest
- Vulnerability
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
lusid_scheduler_sdk-2.3.1.tar.gz
(66.8 kB
view details)
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 lusid_scheduler_sdk-2.3.1.tar.gz.
File metadata
- Download URL: lusid_scheduler_sdk-2.3.1.tar.gz
- Upload date:
- Size: 66.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.2.1 CPython/3.11.9 Linux/6.12.54-flatcar
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
35b46e65feab878cc3156cb88584a5c632c1da28c27f5847156293c28ac5e244
|
|
| MD5 |
05cb344008b217e8f132609aff32c753
|
|
| BLAKE2b-256 |
56a288e7a3c6b2a52218436ac4c652e55f5377207c64379a70128cdf187e2057
|
File details
Details for the file lusid_scheduler_sdk-2.3.1-py3-none-any.whl.
File metadata
- Download URL: lusid_scheduler_sdk-2.3.1-py3-none-any.whl
- Upload date:
- Size: 131.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.2.1 CPython/3.11.9 Linux/6.12.54-flatcar
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
50293f6d78c433357705f6381ab2b32864d8ac8691cb6d196bd291ecbdc2f13a
|
|
| MD5 |
03bfb71f1a5cb0cebdce0c62f99ff15b
|
|
| BLAKE2b-256 |
0190e30d5b8eaa22bfa8026d9936592da91312b01490fd3f7ea080688165bba4
|