swagger-client

This Python package is automatically generated by the Swagger Codegen project:

• API version:
• Package version: 1.0.0
• Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import swagger_client 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import swagger_client

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.JobsApi(swagger_client.ApiClient(configuration))
job_id = 'job_id_example' # str | The id of a job

try:
    # cancel a job execution, remove a finished job
    api_response = api_instance.dismiss1(job_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobsApi->dismiss1: %s\n" % e)

# create an instance of the API class
api_instance = swagger_client.JobsApi(swagger_client.ApiClient(configuration))
body = swagger_client.BeSpacebelAltiusProcessingModelExecutionRequest() # BeSpacebelAltiusProcessingModelExecutionRequest | 

try:
    # Execute a process.
    api_response = api_instance.execute1(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobsApi->execute1: %s\n" % e)

# create an instance of the API class
api_instance = swagger_client.JobsApi(swagger_client.ApiClient(configuration))
job_id = 'job_id_example' # str | The id of a job

try:
    # Retrieve logs of a job
    api_response = api_instance.get_logs1(job_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobsApi->get_logs1: %s\n" % e)

# create an instance of the API class
api_instance = swagger_client.JobsApi(swagger_client.ApiClient(configuration))
job_id = 'job_id_example' # str | The id of a job

try:
    # Retrieve the information about a job (status, results)
    api_response = api_instance.get_status1(job_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobsApi->get_status1: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to /

Class	Method	HTTP request	Description
JobsApi	dismiss1	DELETE /processing/jobs/{jobID}	cancel a job execution, remove a finished job
JobsApi	execute1	POST /processing/jobs	Execute a process.
JobsApi	get_logs1	GET /processing/jobs/{jobID}/logs	Retrieve logs of a job
JobsApi	get_status1	GET /processing/jobs/{jobID}	Retrieve the information about a job (status, results)
LegacyApi	get_landing_page	GET /processing	landing page of this API
LegacyApi	get_requirements_classes	GET /processing/conformance	information about standards that this API conforms to (optional implementation in ALTIUS)
DefaultApi	get	GET /processing/openapi
DefaultApi	get_checks1	GET /processing/health
DefaultApi	get_json123	GET /processing/metrics/{registry}/{metric}
DefaultApi	get_json12345	GET /processing/metrics
DefaultApi	get_metadata12	OPTIONS /processing/metrics/{registry}
DefaultApi	get_metadata123	OPTIONS /processing/metrics/{registry}/{metric}
DefaultApi	get_text12345	GET /processing/metrics/{registry}

Documentation For Models

• BeSpacebelAltiusProcessingModelExecutionRequest
• BeSpacebelAltiusProcessingModelJobInfo
• BeSpacebelAltiusProcessingModelResults
• BeSpacebelAltiusProcessingTransactionalModelExceptionReportType
• BeSpacebelAltiusProcessingTransactionalModelLandingPage
• BeSpacebelAltiusProcessingTransactionalModelLink
• BeSpacebelAltiusProcessingTransactionalModelReqClasses
• JavaLangObject
• JavaMathBigDecimal
• OrgEclipseMicroprofileOpenapiModelsComponents
• OrgEclipseMicroprofileOpenapiModelsExternalDocumentation
• OrgEclipseMicroprofileOpenapiModelsInfoContact
• OrgEclipseMicroprofileOpenapiModelsInfoInfo
• OrgEclipseMicroprofileOpenapiModelsInfoLicense
• OrgEclipseMicroprofileOpenapiModelsMediaContent
• OrgEclipseMicroprofileOpenapiModelsMediaDiscriminator
• OrgEclipseMicroprofileOpenapiModelsMediaMediaType
• OrgEclipseMicroprofileOpenapiModelsMediaSchema
• OrgEclipseMicroprofileOpenapiModelsMediaXML
• OrgEclipseMicroprofileOpenapiModelsOpenAPI
• OrgEclipseMicroprofileOpenapiModelsOperation
• OrgEclipseMicroprofileOpenapiModelsParametersParameter
• OrgEclipseMicroprofileOpenapiModelsParametersRequestBody
• OrgEclipseMicroprofileOpenapiModelsPathItem
• OrgEclipseMicroprofileOpenapiModelsPaths
• OrgEclipseMicroprofileOpenapiModelsResponsesAPIResponse
• OrgEclipseMicroprofileOpenapiModelsResponsesAPIResponses
• OrgEclipseMicroprofileOpenapiModelsSecuritySecurityRequirement
• OrgEclipseMicroprofileOpenapiModelsServersServer
• OrgEclipseMicroprofileOpenapiModelsServersServerVariable
• OrgEclipseMicroprofileOpenapiModelsServersServerVariables
• OrgEclipseMicroprofileOpenapiModelsTagsTag

Documentation For Authorization

All endpoints do not require authorization.

Author