Skip to content

modelcatalog.RegionApi

All URIs are relative to https://api.models.mint.isi.edu/v1.4.0

Method HTTP request Description
regions_get GET /regions List all Region entities
regions_id_delete DELETE /regions/{id} Delete a Region
regions_id_get GET /regions/{id} Get a Region
regions_id_put PUT /regions/{id} Update a Region
regions_post POST /regions Create a Region

regions_get

list[Region] regions_get(username=username, label=label)

List all Region entities

Gets a list of all Region entities

Example

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

# Create an instance of the API class
api_instance = modelcatalog.RegionApi()
username = 'username_example' # str | Username to query (optional)
label = 'label_example' # str | Filter by label (optional)

try:
    # List all Region entities
    api_response = api_instance.regions_get(username=username, label=label)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RegionApi->regions_get: %s\n" % e)

Parameters

Name Type Description Notes
username str Username to query [optional]
label str Filter by label [optional]

Return type

list[Region]

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful response - returns an array of Region entities. -

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

regions_id_delete

regions_id_delete(id, user)

Delete a Region

Delete an existing Region

Example

  • Bearer (JWT) Authentication (BearerAuth):
from __future__ import print_function
import time
import modelcatalog
from modelcatalog.rest import ApiException
from pprint import pprint
configuration = modelcatalog.Configuration()
# Configure Bearer authorization (JWT): BearerAuth
configuration.access_token = 'YOUR_BEARER_TOKEN'

# Defining host is optional and default to https://api.models.mint.isi.edu/v1.4.0
configuration.host = "https://api.models.mint.isi.edu/v1.4.0"
# Create an instance of the API class
api_instance = modelcatalog.RegionApi(modelcatalog.ApiClient(configuration))
id = 'id_example' # str | The ID of the resource
user = 'user_example' # str | Username

try:
    # Delete a Region
    api_instance.regions_id_delete(id, user)
except ApiException as e:
    print("Exception when calling RegionApi->regions_id_delete: %s\n" % e)

Parameters

Name Type Description Notes
id str The ID of the resource
user str Username

Return type

void (empty response body)

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
202 Deleted -
404 Not Found -

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

regions_id_get

Region regions_id_get(id, username=username)

Get a Region

Gets the details of a single instance of a Region

Example

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

# Create an instance of the API class
api_instance = modelcatalog.RegionApi()
id = 'id_example' # str | The ID of the resource
username = 'username_example' # str | Username to query (optional)

try:
    # Get a Region
    api_response = api_instance.regions_id_get(id, username=username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RegionApi->regions_id_get: %s\n" % e)

Parameters

Name Type Description Notes
id str The ID of the resource
username str Username to query [optional]

Return type

Region

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Gets the details of a single instance of Region -

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

regions_id_put

Region regions_id_put(id, user, region=region)

Update a Region

Updates an existing Region

Example

  • Bearer (JWT) Authentication (BearerAuth):
from __future__ import print_function
import time
import modelcatalog
from modelcatalog.rest import ApiException
from pprint import pprint
configuration = modelcatalog.Configuration()
# Configure Bearer authorization (JWT): BearerAuth
configuration.access_token = 'YOUR_BEARER_TOKEN'

# Defining host is optional and default to https://api.models.mint.isi.edu/v1.4.0
configuration.host = "https://api.models.mint.isi.edu/v1.4.0"
# Create an instance of the API class
api_instance = modelcatalog.RegionApi(modelcatalog.ApiClient(configuration))
id = 'id_example' # str | The ID of the resource
user = 'user_example' # str | Username
region = modelcatalog.Region() # Region | An old Regionto be updated (optional)

try:
    # Update a Region
    api_response = api_instance.regions_id_put(id, user, region=region)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RegionApi->regions_id_put: %s\n" % e)

Parameters

Name Type Description Notes
id str The ID of the resource
user str Username
region Region An old Regionto be updated [optional]

Return type

Region

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Updated -
404 Not Found -

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

regions_post

Region regions_post(user, region=region)

Create a Region

Create a new instance of a Region

Example

  • Bearer (JWT) Authentication (BearerAuth):
from __future__ import print_function
import time
import modelcatalog
from modelcatalog.rest import ApiException
from pprint import pprint
configuration = modelcatalog.Configuration()
# Configure Bearer authorization (JWT): BearerAuth
configuration.access_token = 'YOUR_BEARER_TOKEN'

# Defining host is optional and default to https://api.models.mint.isi.edu/v1.4.0
configuration.host = "https://api.models.mint.isi.edu/v1.4.0"
# Create an instance of the API class
api_instance = modelcatalog.RegionApi(modelcatalog.ApiClient(configuration))
user = 'user_example' # str | Username
region = modelcatalog.Region() # Region | A new Regionto be created (optional)

try:
    # Create a Region
    api_response = api_instance.regions_post(user, region=region)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RegionApi->regions_post: %s\n" % e)

Parameters

Name Type Description Notes
user str Username
region Region A new Regionto be created [optional]

Return type

Region

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
201 Created -

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