Skip to content

Latest commit

 

History

History
266 lines (188 loc) · 9.66 KB

DRUApi.md

File metadata and controls

266 lines (188 loc) · 9.66 KB

unity_sps_ogc_processes_api_python_client.DRUApi

All URIs are relative to http://localhost

Method HTTP request Description
deploy_processes_post POST /processes deploy a process.
replace_processes_process_id_put PUT /processes/{processId} replace a process.
undeploy_processes_process_id_delete DELETE /processes/{processId} undeploy a process.

deploy_processes_post

object deploy_processes_post(w=w, ogcapppkg=ogcapppkg)

deploy a process.

Deploys a process. For more information, see Section 6.3.

Example

  • Bearer (JWT) Authentication (bearerAuth):
import unity_sps_ogc_processes_api_python_client
from unity_sps_ogc_processes_api_python_client.models.ogcapppkg import Ogcapppkg
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.DRUApi(api_client)
    w = 'w_example' # str | Point to the workflow identifier for deploying a CWL containing multiple workflow definitions (optional)
    ogcapppkg = unity_sps_ogc_processes_api_python_client.Ogcapppkg() # Ogcapppkg |  (optional)

    try:
        # deploy a process.
        api_response = api_instance.deploy_processes_post(w=w, ogcapppkg=ogcapppkg)
        print("The response of DRUApi->deploy_processes_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DRUApi->deploy_processes_post: %s\n" % e)

Parameters

Name Type Description Notes
w str Point to the workflow identifier for deploying a CWL containing multiple workflow definitions [optional]
ogcapppkg Ogcapppkg [optional]

Return type

object

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
201 Created -
403 the processes is not mutable -
409 the processes being added is already deployed (i.e. duplicate) -
422 Validation Error -
500 A server error occurred. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

replace_processes_process_id_put

object replace_processes_process_id_put(process_id, ogcapppkg=ogcapppkg)

replace a process.

Replaces a process. For more information, see Section 6.4.

Example

  • Bearer (JWT) Authentication (bearerAuth):
import unity_sps_ogc_processes_api_python_client
from unity_sps_ogc_processes_api_python_client.models.ogcapppkg import Ogcapppkg
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.DRUApi(api_client)
    process_id = 'process_id_example' # str |
    ogcapppkg = unity_sps_ogc_processes_api_python_client.Ogcapppkg() # Ogcapppkg |  (optional)

    try:
        # replace a process.
        api_response = api_instance.replace_processes_process_id_put(process_id, ogcapppkg=ogcapppkg)
        print("The response of DRUApi->replace_processes_process_id_put:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DRUApi->replace_processes_process_id_put: %s\n" % e)

Parameters

Name Type Description Notes
process_id str
ogcapppkg Ogcapppkg [optional]

Return type

object

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
204 successful operation (no response body) -
403 the processes is not mutable -
404 The requested resource does not exist on the server. For example, a path parameter had an incorrect value. -
409 the processes being added is already deployed (i.e. duplicate) -
422 Validation Error -
500 A server error occurred. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

undeploy_processes_process_id_delete

object undeploy_processes_process_id_delete(process_id, force=force)

undeploy a process.

Undeploys a process. For more information, see Section 6.5.

Example

  • Bearer (JWT) Authentication (bearerAuth):
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.DRUApi(api_client)
    process_id = 'process_id_example' # str |
    force = False # bool | Force undeployment even if there are active DAG runs (optional) (default to False)

    try:
        # undeploy a process.
        api_response = api_instance.undeploy_processes_process_id_delete(process_id, force=force)
        print("The response of DRUApi->undeploy_processes_process_id_delete:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DRUApi->undeploy_processes_process_id_delete: %s\n" % e)

Parameters

Name Type Description Notes
process_id str
force bool Force undeployment even if there are active DAG runs [optional] [default to False]

Return type

object

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
204 successful operation (no response body) -
403 the processes is not mutable -
404 The requested resource does not exist on the server. For example, a path parameter had an incorrect value. -
409 The process has active DAG runs and force is not set to true. -
422 Validation Error -
500 A server error occurred. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]