Skip to content

modelcatalog.PersonApi

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

Method HTTP request Description
persons_get GET /persons List all Person entities
persons_id_delete DELETE /persons/{id} Delete a Person
persons_id_get GET /persons/{id} Get a Person
persons_id_put PUT /persons/{id} Update a Person
persons_post POST /persons Create a Person

persons_get

list[Person] persons_get(username=username, label=label)

List all Person entities

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

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

Parameters

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

Return type

list[Person]

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

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

persons_id_delete

persons_id_delete(id, user)

Delete a Person

Delete an existing Person

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

try:
    # Delete a Person
    api_instance.persons_id_delete(id, user)
except ApiException as e:
    print("Exception when calling PersonApi->persons_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]

persons_id_get

Person persons_id_get(id, username=username)

Get a Person

Gets the details of a single instance of a Person

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

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

Person

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

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

persons_id_put

Person persons_id_put(id, user, person=person)

Update a Person

Updates an existing Person

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

try:
    # Update a Person
    api_response = api_instance.persons_id_put(id, user, person=person)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PersonApi->persons_id_put: %s\n" % e)

Parameters

Name Type Description Notes
id str The ID of the resource
user str Username
person Person An old Personto be updated [optional]

Return type

Person

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]

persons_post

Person persons_post(user, person=person)

Create a Person

Create a new instance of a Person

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.PersonApi(modelcatalog.ApiClient(configuration))
user = 'user_example' # str | Username
person = modelcatalog.Person() # Person | A new Personto be created (optional)

try:
    # Create a Person
    api_response = api_instance.persons_post(user, person=person)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PersonApi->persons_post: %s\n" % e)

Parameters

Name Type Description Notes
user str Username
person Person A new Personto be created [optional]

Return type

Person

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]