Skip to content

BioModelResourceApi.md

Latest commit

 

History

History
287 lines (203 loc) · 8.62 KB

BioModelResourceApi.md

File metadata and controls

287 lines (203 loc) · 8.62 KB

vcell_client.BioModelResourceApi

All URIs are relative to https://vcell.cam.uchc.edu

Method HTTP request Description
delete_bio_model DELETE /api/v1/bioModel/{bioModelID} Delete the BioModel from VCell's database.
get_bio_model GET /api/v1/bioModel/{bioModelID} Get BioModel.
get_bio_model_vcml GET /api/v1/bioModel/{bioModelID}/vcml_download Get the BioModel in VCML format.
save_bio_model POST /api/v1/bioModel/save Save's the given BioModel. Optional parameters of name and simulations to update due to math changes. Returns saved BioModel as VCML.

delete_bio_model

delete_bio_model(bio_model_id)

Delete the BioModel from VCell's database.

Example

import time
import os
import vcell_client
from vcell_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://vcell.cam.uchc.edu
# See configuration.py for a list of all supported configuration parameters.
configuration = vcell_client.Configuration(
    host = "https://vcell.cam.uchc.edu"
)


# Enter a context with an instance of the API client
with vcell_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = vcell_client.BioModelResourceApi(api_client)
    bio_model_id = 'bio_model_id_example' # str | 

    try:
        # Delete the BioModel from VCell's database.
        api_instance.delete_bio_model(bio_model_id)
    except Exception as e:
        print("Exception when calling BioModelResourceApi->delete_bio_model: %s\n" % e)

Parameters

Name Type Description Notes
bio_model_id str

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
204 No Content -
401 Not Authorized -
403 Not Allowed -
500 Data Access Exception -

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

get_bio_model

BioModel get_bio_model(bio_model_id)

Get BioModel.

Example

import time
import os
import vcell_client
from vcell_client.models.bio_model import BioModel
from vcell_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://vcell.cam.uchc.edu
# See configuration.py for a list of all supported configuration parameters.
configuration = vcell_client.Configuration(
    host = "https://vcell.cam.uchc.edu"
)


# Enter a context with an instance of the API client
with vcell_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = vcell_client.BioModelResourceApi(api_client)
    bio_model_id = 'bio_model_id_example' # str | 

    try:
        # Get BioModel.
        api_response = api_instance.get_bio_model(bio_model_id)
        print("The response of BioModelResourceApi->get_bio_model:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BioModelResourceApi->get_bio_model: %s\n" % e)

Parameters

Name Type Description Notes
bio_model_id str

Return type

BioModel

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -
401 Not Authorized -
403 Not Allowed -
404 Not found -
500 Data Access Exception -

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

get_bio_model_vcml

str get_bio_model_vcml(bio_model_id)

Get the BioModel in VCML format.

Example

import time
import os
import vcell_client
from vcell_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://vcell.cam.uchc.edu
# See configuration.py for a list of all supported configuration parameters.
configuration = vcell_client.Configuration(
    host = "https://vcell.cam.uchc.edu"
)


# Enter a context with an instance of the API client
with vcell_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = vcell_client.BioModelResourceApi(api_client)
    bio_model_id = 'bio_model_id_example' # str | 

    try:
        # Get the BioModel in VCML format.
        api_response = api_instance.get_bio_model_vcml(bio_model_id)
        print("The response of BioModelResourceApi->get_bio_model_vcml:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BioModelResourceApi->get_bio_model_vcml: %s\n" % e)

Parameters

Name Type Description Notes
bio_model_id str

Return type

str

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/xml, application/json

HTTP response details

Status code Description Response headers
200 OK -
401 Not Authorized -
403 Not Allowed -
404 Not found -
500 Data Access Exception -

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

save_bio_model

str save_bio_model(save_bio_model=save_bio_model)

Save's the given BioModel. Optional parameters of name and simulations to update due to math changes. Returns saved BioModel as VCML.

Example

import time
import os
import vcell_client
from vcell_client.models.save_bio_model import SaveBioModel
from vcell_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://vcell.cam.uchc.edu
# See configuration.py for a list of all supported configuration parameters.
configuration = vcell_client.Configuration(
    host = "https://vcell.cam.uchc.edu"
)

# 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.

# Enter a context with an instance of the API client
with vcell_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = vcell_client.BioModelResourceApi(api_client)
    save_bio_model = vcell_client.SaveBioModel() # SaveBioModel |  (optional)

    try:
        # Save's the given BioModel. Optional parameters of name and simulations to update due to math changes. Returns saved BioModel as VCML.
        api_response = api_instance.save_bio_model(save_bio_model=save_bio_model)
        print("The response of BioModelResourceApi->save_bio_model:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BioModelResourceApi->save_bio_model: %s\n" % e)

Parameters

Name Type Description Notes
save_bio_model SaveBioModel [optional]

Return type

str

Authorization

openId

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -
401 Not Authorized -
403 Not Allowed -
422 Unprocessable content submitted -
500 Data Access Exception -

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