<a id="documentation-for-api-endpoints"></a>
## 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**](docs/ApplicationMetadataApi.md#list_access_controlled_resources) | **GET** /api/metadata/access/resources | ListAccessControlledResources: Get resources available for access control
*ImagesApi* | [**delete_image**](docs/ImagesApi.md#delete_image) | **DELETE** /api/images/{name} | DeleteImage: Delete a Docker Image
*ImagesApi* | [**download_image**](docs/ImagesApi.md#download_image) | **GET** /api/images/{name}/contents | DownloadImage: Download Docker Image
*ImagesApi* | [**get_image**](docs/ImagesApi.md#get_image) | **GET** /api/images/{name} | GetImage: Get metadata of a Docker Image
*ImagesApi* | [**list_images**](docs/ImagesApi.md#list_images) | **GET** /api/images/repository/{name} | ListImages: List all images under same image repository
*ImagesApi* | [**list_repositories**](docs/ImagesApi.md#list_repositories) | **GET** /api/images/repository | ListRepositories: List all Docker image repositories
*ImagesApi* | [**upload_image**](docs/ImagesApi.md#upload_image) | **POST** /api/images | UploadImage: Upload a Docker Image used for Scheduler jobs
*JobsApi* | [**create_job**](docs/JobsApi.md#create_job) | **POST** /api/jobs | CreateJob: Create a new job
*JobsApi* | [**delete_job**](docs/JobsApi.md#delete_job) | **DELETE** /api/jobs/{scope}/{code} | DeleteJob: Delete a job
*JobsApi* | [**get_history**](docs/JobsApi.md#get_history) | **GET** /api/jobs/history | GetHistory: Get the history of job runs
*JobsApi* | [**get_job_console_output**](docs/JobsApi.md#get_job_console_output) | **GET** /api/jobs/history/{runId}/console | GetJobConsoleOutput: Gets the console output of a specific job run
*JobsApi* | [**get_run_history**](docs/JobsApi.md#get_run_history) | **GET** /api/jobs/history/{runId} | GetRunHistory: Get the history for a single job run
*JobsApi* | [**get_schedules_for_a_job**](docs/JobsApi.md#get_schedules_for_a_job) | **GET** /api/jobs/{scope}/{code}/schedules | GetSchedulesForAJob: Get all the schedules for a single job
*JobsApi* | [**list_jobs**](docs/JobsApi.md#list_jobs) | **GET** /api/jobs | ListJobs: List the available jobs
*JobsApi* | [**run_job**](docs/JobsApi.md#run_job) | **POST** /api/jobs/{scope}/{code}/$run | RunJob: Run a job immediately
*JobsApi* | [**update_job**](docs/JobsApi.md#update_job) | **PUT** /api/jobs/{scope}/{code} | UpdateJob: Update a JobDefinition
*SchedulesApi* | [**create_schedule**](docs/SchedulesApi.md#create_schedule) | **POST** /api/schedules | CreateSchedule: Create a Schedule for a job
*SchedulesApi* | [**delete_schedule**](docs/SchedulesApi.md#delete_schedule) | **DELETE** /api/schedules/{scope}/{code} | DeleteSchedule: Delete a schedule
*SchedulesApi* | [**enabled_schedule**](docs/SchedulesApi.md#enabled_schedule) | **PUT** /api/schedules/{scope}/{code}/enabled | EnabledSchedule: Enable/disable a schedule
*SchedulesApi* | [**get_schedule**](docs/SchedulesApi.md#get_schedule) | **GET** /api/schedules/{scope}/{code} | GetSchedule: Get a single Schedule
*SchedulesApi* | [**get_valid_timezones**](docs/SchedulesApi.md#get_valid_timezones) | **GET** /api/schedules/{scope}/{code}/enabled | GetValidTimezones: Get a list of valid timezones
*SchedulesApi* | [**list_schedules**](docs/SchedulesApi.md#list_schedules) | **GET** /api/schedules | ListSchedules: List the available Schedules
*SchedulesApi* | [**run_schedule**](docs/SchedulesApi.md#run_schedule) | **POST** /api/schedules/{scope}/{code}/$run | RunSchedule: Run a schedule immediately
*SchedulesApi* | [**update_schedule**](docs/SchedulesApi.md#update_schedule) | **PUT** /api/schedules/{scope}/{code} | UpdateSchedule: Update a schedule.
<a id="documentation-for-models"></a>
## Documentation for Models
- [AccessControlledAction](docs/AccessControlledAction.md)
- [AccessControlledResource](docs/AccessControlledResource.md)
- [ActionId](docs/ActionId.md)
- [ArgumentDefinition](docs/ArgumentDefinition.md)
- [CreateJobRequest](docs/CreateJobRequest.md)
- [CreateScheduleRequest](docs/CreateScheduleRequest.md)
- [IdSelectorDefinition](docs/IdSelectorDefinition.md)
- [IdentifierPartSchema](docs/IdentifierPartSchema.md)
- [Image](docs/Image.md)
- [ImageSummary](docs/ImageSummary.md)
- [JobDefinition](docs/JobDefinition.md)
- [JobHistory](docs/JobHistory.md)
- [JobRunResult](docs/JobRunResult.md)
- [Link](docs/Link.md)
- [LusidProblemDetails](docs/LusidProblemDetails.md)
- [LusidValidationProblemDetails](docs/LusidValidationProblemDetails.md)
- [Notification](docs/Notification.md)
- [Repository](docs/Repository.md)
- [RequiredResources](docs/RequiredResources.md)
- [ResourceId](docs/ResourceId.md)
- [ResourceListOfAccessControlledResource](docs/ResourceListOfAccessControlledResource.md)
- [ResourceListOfImageSummary](docs/ResourceListOfImageSummary.md)
- [ResourceListOfJobDefinition](docs/ResourceListOfJobDefinition.md)
- [ResourceListOfJobHistory](docs/ResourceListOfJobHistory.md)
- [ResourceListOfRepository](docs/ResourceListOfRepository.md)
- [ResourceListOfScheduleDefinition](docs/ResourceListOfScheduleDefinition.md)
- [ResourceListOfString](docs/ResourceListOfString.md)
- [ScanReport](docs/ScanReport.md)
- [ScanSummary](docs/ScanSummary.md)
- [ScheduleDefinition](docs/ScheduleDefinition.md)
- [StartJobRequest](docs/StartJobRequest.md)
- [StartJobResponse](docs/StartJobResponse.md)
- [StartScheduleResponse](docs/StartScheduleResponse.md)
- [Tag](docs/Tag.md)
- [TimeTrigger](docs/TimeTrigger.md)
- [Trigger](docs/Trigger.md)
- [UpdateJobRequest](docs/UpdateJobRequest.md)
- [UpdateScheduleRequest](docs/UpdateScheduleRequest.md)
- [UploadImageInstructions](docs/UploadImageInstructions.md)
- [UploadImageRequest](docs/UploadImageRequest.md)
- [Vulnerability](docs/Vulnerability.md)
Raw data
{
"_id": null,
"home_page": "https://github.com/finbourne/scheduler-sdk-python",
"name": "lusid-scheduler-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, FINBOURNE Scheduler API, lusid-scheduler-sdk",
"author": "FINBOURNE Technology",
"author_email": "info@finbourne.com",
"download_url": "https://files.pythonhosted.org/packages/ec/45/bd7b1c1f7f5ce3bef36f477eb9a34394e621d7f83b9926167abfe68f7dab/lusid_scheduler_sdk-2.1.97.tar.gz",
"platform": null,
"description": "<a id=\"documentation-for-api-endpoints\"></a>\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://fbn-prd.lusid.com/scheduler2*\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 | ListAccessControlledResources: Get resources available for access control\n*ImagesApi* | [**delete_image**](docs/ImagesApi.md#delete_image) | **DELETE** /api/images/{name} | DeleteImage: Delete a Docker Image\n*ImagesApi* | [**download_image**](docs/ImagesApi.md#download_image) | **GET** /api/images/{name}/contents | DownloadImage: Download Docker Image\n*ImagesApi* | [**get_image**](docs/ImagesApi.md#get_image) | **GET** /api/images/{name} | GetImage: Get metadata of a Docker Image\n*ImagesApi* | [**list_images**](docs/ImagesApi.md#list_images) | **GET** /api/images/repository/{name} | ListImages: List all images under same image repository\n*ImagesApi* | [**list_repositories**](docs/ImagesApi.md#list_repositories) | **GET** /api/images/repository | ListRepositories: List all Docker image repositories\n*ImagesApi* | [**upload_image**](docs/ImagesApi.md#upload_image) | **POST** /api/images | UploadImage: Upload a Docker Image used for Scheduler jobs\n*JobsApi* | [**create_job**](docs/JobsApi.md#create_job) | **POST** /api/jobs | CreateJob: Create a new job\n*JobsApi* | [**delete_job**](docs/JobsApi.md#delete_job) | **DELETE** /api/jobs/{scope}/{code} | DeleteJob: Delete a job\n*JobsApi* | [**get_history**](docs/JobsApi.md#get_history) | **GET** /api/jobs/history | GetHistory: Get the history of job runs\n*JobsApi* | [**get_job_console_output**](docs/JobsApi.md#get_job_console_output) | **GET** /api/jobs/history/{runId}/console | GetJobConsoleOutput: Gets the console output of a specific job run\n*JobsApi* | [**get_run_history**](docs/JobsApi.md#get_run_history) | **GET** /api/jobs/history/{runId} | GetRunHistory: Get the history for a single job run\n*JobsApi* | [**get_schedules_for_a_job**](docs/JobsApi.md#get_schedules_for_a_job) | **GET** /api/jobs/{scope}/{code}/schedules | GetSchedulesForAJob: Get all the schedules for a single job\n*JobsApi* | [**list_jobs**](docs/JobsApi.md#list_jobs) | **GET** /api/jobs | ListJobs: List the available jobs\n*JobsApi* | [**run_job**](docs/JobsApi.md#run_job) | **POST** /api/jobs/{scope}/{code}/$run | RunJob: Run a job immediately\n*JobsApi* | [**update_job**](docs/JobsApi.md#update_job) | **PUT** /api/jobs/{scope}/{code} | UpdateJob: Update a JobDefinition\n*SchedulesApi* | [**create_schedule**](docs/SchedulesApi.md#create_schedule) | **POST** /api/schedules | CreateSchedule: Create a Schedule for a job\n*SchedulesApi* | [**delete_schedule**](docs/SchedulesApi.md#delete_schedule) | **DELETE** /api/schedules/{scope}/{code} | DeleteSchedule: Delete a schedule\n*SchedulesApi* | [**enabled_schedule**](docs/SchedulesApi.md#enabled_schedule) | **PUT** /api/schedules/{scope}/{code}/enabled | EnabledSchedule: Enable/disable a schedule\n*SchedulesApi* | [**get_schedule**](docs/SchedulesApi.md#get_schedule) | **GET** /api/schedules/{scope}/{code} | GetSchedule: Get a single Schedule\n*SchedulesApi* | [**get_valid_timezones**](docs/SchedulesApi.md#get_valid_timezones) | **GET** /api/schedules/{scope}/{code}/enabled | GetValidTimezones: Get a list of valid timezones\n*SchedulesApi* | [**list_schedules**](docs/SchedulesApi.md#list_schedules) | **GET** /api/schedules | ListSchedules: List the available Schedules\n*SchedulesApi* | [**run_schedule**](docs/SchedulesApi.md#run_schedule) | **POST** /api/schedules/{scope}/{code}/$run | RunSchedule: Run a schedule immediately\n*SchedulesApi* | [**update_schedule**](docs/SchedulesApi.md#update_schedule) | **PUT** /api/schedules/{scope}/{code} | UpdateSchedule: Update a schedule.\n\n\n<a id=\"documentation-for-models\"></a>\n## Documentation for Models\n\n - [AccessControlledAction](docs/AccessControlledAction.md)\n - [AccessControlledResource](docs/AccessControlledResource.md)\n - [ActionId](docs/ActionId.md)\n - [ArgumentDefinition](docs/ArgumentDefinition.md)\n - [CreateJobRequest](docs/CreateJobRequest.md)\n - [CreateScheduleRequest](docs/CreateScheduleRequest.md)\n - [IdSelectorDefinition](docs/IdSelectorDefinition.md)\n - [IdentifierPartSchema](docs/IdentifierPartSchema.md)\n - [Image](docs/Image.md)\n - [ImageSummary](docs/ImageSummary.md)\n - [JobDefinition](docs/JobDefinition.md)\n - [JobHistory](docs/JobHistory.md)\n - [JobRunResult](docs/JobRunResult.md)\n - [Link](docs/Link.md)\n - [LusidProblemDetails](docs/LusidProblemDetails.md)\n - [LusidValidationProblemDetails](docs/LusidValidationProblemDetails.md)\n - [Notification](docs/Notification.md)\n - [Repository](docs/Repository.md)\n - [RequiredResources](docs/RequiredResources.md)\n - [ResourceId](docs/ResourceId.md)\n - [ResourceListOfAccessControlledResource](docs/ResourceListOfAccessControlledResource.md)\n - [ResourceListOfImageSummary](docs/ResourceListOfImageSummary.md)\n - [ResourceListOfJobDefinition](docs/ResourceListOfJobDefinition.md)\n - [ResourceListOfJobHistory](docs/ResourceListOfJobHistory.md)\n - [ResourceListOfRepository](docs/ResourceListOfRepository.md)\n - [ResourceListOfScheduleDefinition](docs/ResourceListOfScheduleDefinition.md)\n - [ResourceListOfString](docs/ResourceListOfString.md)\n - [ScanReport](docs/ScanReport.md)\n - [ScanSummary](docs/ScanSummary.md)\n - [ScheduleDefinition](docs/ScheduleDefinition.md)\n - [StartJobRequest](docs/StartJobRequest.md)\n - [StartJobResponse](docs/StartJobResponse.md)\n - [StartScheduleResponse](docs/StartScheduleResponse.md)\n - [Tag](docs/Tag.md)\n - [TimeTrigger](docs/TimeTrigger.md)\n - [Trigger](docs/Trigger.md)\n - [UpdateJobRequest](docs/UpdateJobRequest.md)\n - [UpdateScheduleRequest](docs/UpdateScheduleRequest.md)\n - [UploadImageInstructions](docs/UploadImageInstructions.md)\n - [UploadImageRequest](docs/UploadImageRequest.md)\n - [Vulnerability](docs/Vulnerability.md)\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "FINBOURNE Scheduler API",
"version": "2.1.97",
"project_urls": {
"Homepage": "https://github.com/finbourne/scheduler-sdk-python",
"Repository": "https://github.com/finbourne/scheduler-sdk-python"
},
"split_keywords": [
"openapi",
" openapi-generator",
" finbourne scheduler api",
" lusid-scheduler-sdk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "321e062e064156e1c3020827a7e53d7103047b0d7ed940984172702f190c160e",
"md5": "824a132a4c34d04debbb94fd5201a9ef",
"sha256": "ae489c0cde685ad66cb9369d3da38d438cf045847008ea1834de613e02b56487"
},
"downloads": -1,
"filename": "lusid_scheduler_sdk-2.1.97-py3-none-any.whl",
"has_sig": false,
"md5_digest": "824a132a4c34d04debbb94fd5201a9ef",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 127852,
"upload_time": "2025-04-09T10:51:28",
"upload_time_iso_8601": "2025-04-09T10:51:28.438568Z",
"url": "https://files.pythonhosted.org/packages/32/1e/062e064156e1c3020827a7e53d7103047b0d7ed940984172702f190c160e/lusid_scheduler_sdk-2.1.97-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ec45bd7b1c1f7f5ce3bef36f477eb9a34394e621d7f83b9926167abfe68f7dab",
"md5": "07a5d132fb350ffc45fd001822578f41",
"sha256": "8ebb526bac55350c1f91436c9e479020790385db631e29bffd643054a4f5a9fc"
},
"downloads": -1,
"filename": "lusid_scheduler_sdk-2.1.97.tar.gz",
"has_sig": false,
"md5_digest": "07a5d132fb350ffc45fd001822578f41",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 68700,
"upload_time": "2025-04-09T10:51:29",
"upload_time_iso_8601": "2025-04-09T10:51:29.961561Z",
"url": "https://files.pythonhosted.org/packages/ec/45/bd7b1c1f7f5ce3bef36f477eb9a34394e621d7f83b9926167abfe68f7dab/lusid_scheduler_sdk-2.1.97.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-04-09 10:51:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "finbourne",
"github_project": "scheduler-sdk-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "lusid-scheduler-sdk"
}
JSON
