unity-sps-ogc-processes-api-python-client 1.0.0

Unity Processing API conforming to the OGC API - Processes - Part 1 standard

unity-sps-ogc-processes-api-python-client

This document is an API definition document provided alongside the OGC API - Processes standard. The OGC API - Processes Standard specifies a processing interface to communicate over a RESTful protocol using JavaScript Object Notation (JSON) encodings. The specification allows for the wrapping of computational tasks into executable processes that can be offered by a server and be invoked by a client application.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.0
• Generator version: 7.5.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

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 unity_sps_ogc_processes_api_python_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 unity_sps_ogc_processes_api_python_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import unity_sps_ogc_processes_api_python_client
from unity_sps_ogc_processes_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = unity_sps_ogc_processes_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = unity_sps_ogc_processes_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with unity_sps_ogc_processes_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = unity_sps_ogc_processes_api_python_client.DefaultApi(api_client)

    try:
        # Information about standards that this API conforms to
        api_response = api_instance.conformance_declaration_conformance_get()
        print("The response of DefaultApi->conformance_declaration_conformance_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DefaultApi->conformance_declaration_conformance_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
DefaultApi	conformance_declaration_conformance_get	GET /conformance	Information about standards that this API conforms to
DefaultApi	deploy_process_processes_post	POST /processes	Deploy a process
DefaultApi	dismiss_jobs_job_id_delete	DELETE /jobs/{job_id}	Cancel a job execution, remove a finished job
DefaultApi	execute_processes_process_id_execution_post	POST /processes/{process_id}/execution	Execute a process
DefaultApi	get_health_health_get	GET /health	Perform a Health Check
DefaultApi	job_list_jobs_get	GET /jobs	Retrieve the list of jobs
DefaultApi	landing_page_get	GET /	Landing page of this API
DefaultApi	process_description_processes_process_id_get	GET /processes/{process_id}	Retrieve a process description
DefaultApi	process_list_processes_get	GET /processes	Retrieve the list of available processes
DefaultApi	results_jobs_job_id_results_get	GET /jobs/{job_id}/results	Retrieve the result(s) of a job
DefaultApi	status_jobs_job_id_get	GET /jobs/{job_id}	Retrieve the status of a job
DefaultApi	undeploy_process_processes_process_id_delete	DELETE /processes/{process_id}	Undeploy a process

Documentation For Models

• Bbox
• ConfClasses
• Crs
• Crs5
• Exception
• Execute
• HTTPValidationError
• HealthCheck
• InputValueInput
• InputValueNoObjectInput
• InputValueNoObjectOutput
• InputValueOutput
• JobControlOptions
• JobList
• LandingPage
• Link
• Metadata
• Metadata1
• Metadata2
• ProcessInput
• ProcessList
• ProcessOutput
• ProcessSummary
• StatusCode
• StatusInfo
• Subscriber
• ValidationError
• ValidationErrorLocInner
• Value

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: Bearer authentication (JWT)

Author