Skip to content

modelcatalog.GridApi

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

Method HTTP request Description
grids_get GET /grids List all Grid entities
grids_id_delete DELETE /grids/{id} Delete a Grid
grids_id_get GET /grids/{id} Get a Grid
grids_id_put PUT /grids/{id} Update a Grid
grids_post POST /grids Create a Grid

grids_get

list[Grid] grids_get(username=username, label=label)

List all Grid entities

Gets a list of all Grid 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.GridApi()
username = 'username_example' # str | Username to query (optional)
label = 'label_example' # str | Filter by label (optional)

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

Parameters

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

Return type

list[Grid]

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 Grid entities. -

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

grids_id_delete

grids_id_delete(id, user)

Delete a Grid

Delete an existing Grid

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.GridApi(modelcatalog.ApiClient(configuration))
id = 'id_example' # str | The ID of the resource
user = 'user_example' # str | Username

try:
    # Delete a Grid
    api_instance.grids_id_delete(id, user)
except ApiException as e:
    print("Exception when calling GridApi->grids_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]

grids_id_get

Grid grids_id_get(id, username=username)

Get a Grid

Gets the details of a single instance of a Grid

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.GridApi()
id = 'id_example' # str | The ID of the resource
username = 'username_example' # str | Username to query (optional)

try:
    # Get a Grid
    api_response = api_instance.grids_id_get(id, username=username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GridApi->grids_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

Grid

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 Grid -

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

grids_id_put

Grid grids_id_put(id, user, grid=grid)

Update a Grid

Updates an existing Grid

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.GridApi(modelcatalog.ApiClient(configuration))
id = 'id_example' # str | The ID of the resource
user = 'user_example' # str | Username
grid = modelcatalog.Grid() # Grid | An old Gridto be updated (optional)

try:
    # Update a Grid
    api_response = api_instance.grids_id_put(id, user, grid=grid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GridApi->grids_id_put: %s\n" % e)

Parameters

Name Type Description Notes
id str The ID of the resource
user str Username
grid Grid An old Gridto be updated [optional]

Return type

Grid

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]

grids_post

Grid grids_post(user, grid=grid)

Create a Grid

Create a new instance of a Grid

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.GridApi(modelcatalog.ApiClient(configuration))
user = 'user_example' # str | Username
grid = modelcatalog.Grid() # Grid | A new Gridto be created (optional)

try:
    # Create a Grid
    api_response = api_instance.grids_post(user, grid=grid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GridApi->grids_post: %s\n" % e)

Parameters

Name Type Description Notes
user str Username
grid Grid A new Gridto be created [optional]

Return type

Grid

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]