data/python-restclient/docs/BioModelResourceApi.md

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_summaries	GET /api/v1/bioModel/summaries	Return BioModel summaries.
get_bio_model_summary	GET /api/v1/bioModel/{bioModelID}/summary	All of the text based information about a BioModel (summary, version, publication status, etc...), but not the actual BioModel itself.
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'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 Authenticated	-
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	-
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_summaries

List[BioModelSummary] get_bio_model_summaries(include_public_and_shared=include_public_and_shared)

Return BioModel summaries.

Example

import time
import os
import vcell_client
from vcell_client.models.bio_model_summary import BioModelSummary
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)
    include_public_and_shared = True # bool | Includes BioModel summaries that are public or shared with requester. Default is true. (optional)

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

Parameters

Name	Type	Description	Notes
include_public_and_shared	bool	Includes BioModel summaries that are public or shared with requester. Default is true.	[optional]

Return type

List[BioModelSummary]

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
500	Data Access Exception	-

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

get_bio_model_summary

BioModelSummary get_bio_model_summary(bio_model_id)

All of the text based information about a BioModel (summary, version, publication status, etc...), but not the actual BioModel itself.

Example

import time
import os
import vcell_client
from vcell_client.models.bio_model_summary import BioModelSummary
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:
        # All of the text based information about a BioModel (summary, version, publication status, etc...), but not the actual BioModel itself.
        api_response = api_instance.get_bio_model_summary(bio_model_id)
        print("The response of BioModelResourceApi->get_bio_model_summary:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BioModelResourceApi->get_bio_model_summary: %s\n" % e)

Parameters

Name	Type	Description	Notes
bio_model_id	str

Return type

BioModelSummary

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
403	Not Allowed	-
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	-
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(body, new_name=new_name, sims_requiring_updates=sims_requiring_updates)

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.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)
    body = 'body_example' # str | BioModelVCML which will be saved.
    new_name = 'new_name_example' # str | Name to save new BioModel under. Leave blank if re-saving existing BioModel. (optional)
    sims_requiring_updates = ['sims_requiring_updates_example'] # List[str] | The name of simulations that will be prepared for future execution. (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(body, new_name=new_name, sims_requiring_updates=sims_requiring_updates)
        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
body	str	BioModelVCML which will be saved.
new_name	str	Name to save new BioModel under. Leave blank if re-saving existing BioModel.	[optional]
sims_requiring_updates	List[str]	The name of simulations that will be prepared for future execution.	[optional]

Return type

str

Authorization

openId

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Not Authenticated	-
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]