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 | [EXPERIMENTAL] ListAccessControlledResources: Get resources available for access control |
ImagesApi | delete_image | DELETE /api/images/{name} | [EXPERIMENTAL] DeleteImage: Delete a Docker Image |
ImagesApi | download_image | GET /api/images/{name}/contents | [EXPERIMENTAL] DownloadImage: Download Docker Image |
ImagesApi | get_image | GET /api/images/{name} | [EXPERIMENTAL] GetImage: Get metadata of a Docker Image |
ImagesApi | list_images | GET /api/images/repository/{name} | [EXPERIMENTAL] ListImages: List all images under same image repository |
ImagesApi | list_repositories | GET /api/images/repository | [EXPERIMENTAL] ListRepositories: List all Docker image repositories |
ImagesApi | upload_image | POST /api/images | [EXPERIMENTAL] UploadImage: Upload a Docker Image used for Scheduler jobs |
JobsApi | create_job | POST /api/jobs | [EXPERIMENTAL] CreateJob: Create a new job |
JobsApi | delete_job | DELETE /api/jobs/{scope}/{code} | [EXPERIMENTAL] DeleteJob: Delete a job |
JobsApi | get_history | GET /api/jobs/history | [EXPERIMENTAL] GetHistory: Get the history of job runs |
JobsApi | get_job_console_output | GET /api/jobs/history/{runId}/console | [EXPERIMENTAL] GetJobConsoleOutput: Gets the console output of a specific job run |
JobsApi | get_run_history | GET /api/jobs/history/{runId} | [EXPERIMENTAL] GetRunHistory: Get the history for a single job run |
JobsApi | get_schedules_for_a_job | GET /api/jobs/{scope}/{code}/schedules | [EXPERIMENTAL] GetSchedulesForAJob: Get all the schedules for a single job |
JobsApi | list_jobs | GET /api/jobs | [EXPERIMENTAL] 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} | [EXPERIMENTAL] UpdateJob: Update a JobDefinition |
SchedulesApi | create_schedule | POST /api/schedules | [EXPERIMENTAL] CreateSchedule: Create a Schedule for a job |
SchedulesApi | delete_schedule | DELETE /api/schedules/{scope}/{code} | [EXPERIMENTAL] DeleteSchedule: Delete a schedule |
SchedulesApi | enabled_schedule | PUT /api/schedules/{scope}/{code}/enabled | [EXPERIMENTAL] EnabledSchedule: Enable/disable a schedule |
SchedulesApi | get_schedule | GET /api/schedules/{scope}/{code} | [EXPERIMENTAL] GetSchedule: Get a single Schedule |
SchedulesApi | list_schedules | GET /api/schedules | [EXPERIMENTAL] ListSchedules: List the available Schedules |
SchedulesApi | run_schedule | POST /api/schedules/{scope}/{code}/$run | [EXPERIMENTAL] RunSchedule: Run a schedule immediately |
SchedulesApi | update_schedule | PUT /api/schedules/{scope}/{code} | [EXPERIMENTAL] 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
- 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
Built Distribution
File details
Details for the file lusid_scheduler_sdk-2.1.59.tar.gz
.
File metadata
- Download URL: lusid_scheduler_sdk-2.1.59.tar.gz
- Upload date:
- Size: 68.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.3 CPython/3.8.2 Linux/6.6.48-flatcar
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a04157a3195c7c774310c15095033be97c946768a1294c2cb9fe85cfc93bfafe |
|
MD5 | 6eb48d33564f13f0bb0ac5631eb13670 |
|
BLAKE2b-256 | b0f3a3ff03eeffca577580778211cb5df263d497f37ff4eba0df117bb3b60fca |
File details
Details for the file lusid_scheduler_sdk-2.1.59-py3-none-any.whl
.
File metadata
- Download URL: lusid_scheduler_sdk-2.1.59-py3-none-any.whl
- Upload date:
- Size: 125.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.3 CPython/3.8.2 Linux/6.6.48-flatcar
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 09d930ee866abda908fd43076b139779d75e46ad96359718774c92c3235b3fbd |
|
MD5 | ff24c9fa0579c087de9af807234c0380 |
|
BLAKE2b-256 | ceb77977c459d712f849ded6ebef1a97ce9888e111eaac994d06b011e1f961ae |