Optimization Server Master RESTful API Copyright © 2018 DecisionBrain.
This Python package is automatically generated by the OpenAPI Generator project:
Python 2.7 and 3.4+
Please follow the installation procedure and then run the following:
from __future__ import print_function
import time
import optimserverclientpython
from optimserverclientpython.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = optimserverclientpython.BucketApi(optimserverclientpython.ApiClient(configuration))
bucket_creation = optimserverclientpython.BucketCreation() # BucketCreation |
try:
# Creates a new Bucket, and returns its ID for later use.
api_response = api_instance.create_bucket(bucket_creation)
pprint(api_response)
except ApiException as e:
print("Exception when calling BucketApi->create_bucket: %s\n" % e)
All URIs are relative to https://dbos
Class | Method | HTTP request | Description |
---|---|---|---|
BucketApi | create_bucket | POST /buckets | Creates a new Bucket, and returns its ID for later use. |
BucketApi | delete_bucket | DELETE /buckets/{bucketId} | Deletes this bucket. |
BucketApi | get_bucket | GET /buckets/{bucketId} | Return a bucket object. |
BucketApi | get_bucket_content | GET /buckets/{bucketId}/content | Returns the content of the requested bucket. |
BucketApi | get_buckets | GET /buckets | Returns requested bucket definitions. |
BucketApi | get_buckets_content | GET /buckets/content | Returns an archive containing the compressed content of requested buckets. |
FlowApi | create_flow | POST /jobFlows | Creates a new Flow, and returns its ID for later use. |
FlowApi | get_job_definitions_by_flow | GET /jobFlows/{flowId}/jobs | Returns job definitions for the given flow ID. |
FlowApi | get_job_flow | GET /jobFlows/{flowId} | Returns a Flow with the given ID, if any. |
FlowApi | get_job_flows | GET /jobFlows | Returns all known flows. |
JobApi | create_job | POST /jobs | Creates a new asyncron Job (without starting it), and returns its ID for later use. |
JobApi | delete_job | DELETE /jobs/{jobId} | Deletes this job and cleans all related data. |
JobApi | get_job_definition | GET /jobs/{jobId} | Returns a job definition. |
JobApi | get_jobs | GET /jobs | Returns all current job definitions. |
JobExecutionApi | get_job_execution_status | GET /jobs/{jobId}/execution | Gets the job execution status. |
JobExecutionApi | start_async_job_execution | POST /jobs/{jobId}/execution | Schedule an already created job for an asyncronous execution. |
JobExecutionApi | start_sync_job_execution | POST /jobs/execution | Schedule a syncron job execution. |
JobExecutionApi | stop_job_execution | DELETE /jobs/{jobId}/execution | Request this job to stop its execution. |
ProjectInformationApi | get_project | GET /project | Gets the project information. |
TaskApi | get_task | GET /tasks/{taskId} | Get a specific task details. |
TaskApi | get_tasks | GET /tasks | Get all known tasks. |
TaskExecutionApi | get_task_execution | GET /tasks/{taskId}/execution | Gets all the jobs execution status for this task. |
optim-server@decisionbrain.com