data/vcell-restclient/docs/BioModelResourceApi.md

BioModelResourceApi

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

Method	HTTP request	Description
deleteBioModel	DELETE /api/v1/bioModel/{bioModelID}	Delete the BioModel from VCell's database.
deleteBioModelWithHttpInfo	DELETE /api/v1/bioModel/{bioModelID}	Delete the BioModel from VCell's database.
getBioModel	GET /api/v1/bioModel/{bioModelID}	Get BioModel.
getBioModelWithHttpInfo	GET /api/v1/bioModel/{bioModelID}	Get BioModel.
getBioModelSummaries	GET /api/v1/bioModel/summaries	Return BioModel summaries.
getBioModelSummariesWithHttpInfo	GET /api/v1/bioModel/summaries	Return BioModel summaries.
getBioModelSummary	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.
getBioModelSummaryWithHttpInfo	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.
getBioModelVCML	GET /api/v1/bioModel/{bioModelID}/vcml_download	Get the BioModel in VCML format.
getBioModelVCMLWithHttpInfo	GET /api/v1/bioModel/{bioModelID}/vcml_download	Get the BioModel in VCML format.
saveBioModel	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.
saveBioModelWithHttpInfo	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.

deleteBioModel

void deleteBioModel(bioModelID)

Delete the BioModel from VCell's database.

Example

// Import classes:
import org.vcell.restclient.ApiClient;
import org.vcell.restclient.ApiException;
import org.vcell.restclient.Configuration;
import org.vcell.restclient.models.*;
import org.vcell.restclient.api.BioModelResourceApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://vcell.cam.uchc.edu");

        BioModelResourceApi apiInstance = new BioModelResourceApi(defaultClient);
        String bioModelID = "bioModelID_example"; // String | 
        try {
            apiInstance.deleteBioModel(bioModelID);
        } catch (ApiException e) {
            System.err.println("Exception when calling BioModelResourceApi#deleteBioModel");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
bioModelID	String

Return type

null (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	-

deleteBioModelWithHttpInfo

ApiResponse deleteBioModel deleteBioModelWithHttpInfo(bioModelID)

Delete the BioModel from VCell's database.

Example

// Import classes:
import org.vcell.restclient.ApiClient;
import org.vcell.restclient.ApiException;
import org.vcell.restclient.ApiResponse;
import org.vcell.restclient.Configuration;
import org.vcell.restclient.models.*;
import org.vcell.restclient.api.BioModelResourceApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://vcell.cam.uchc.edu");

        BioModelResourceApi apiInstance = new BioModelResourceApi(defaultClient);
        String bioModelID = "bioModelID_example"; // String | 
        try {
            ApiResponse<Void> response = apiInstance.deleteBioModelWithHttpInfo(bioModelID);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
        } catch (ApiException e) {
            System.err.println("Exception when calling BioModelResourceApi#deleteBioModel");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
bioModelID	String

Return type

ApiResponse

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	-

getBioModel

BioModel getBioModel(bioModelID)

Get BioModel.

Example

// Import classes:
import org.vcell.restclient.ApiClient;
import org.vcell.restclient.ApiException;
import org.vcell.restclient.Configuration;
import org.vcell.restclient.models.*;
import org.vcell.restclient.api.BioModelResourceApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://vcell.cam.uchc.edu");

        BioModelResourceApi apiInstance = new BioModelResourceApi(defaultClient);
        String bioModelID = "bioModelID_example"; // String | 
        try {
            BioModel result = apiInstance.getBioModel(bioModelID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BioModelResourceApi#getBioModel");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
bioModelID	String

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	-

getBioModelWithHttpInfo

ApiResponse getBioModel getBioModelWithHttpInfo(bioModelID)

Get BioModel.

Example

// Import classes:
import org.vcell.restclient.ApiClient;
import org.vcell.restclient.ApiException;
import org.vcell.restclient.ApiResponse;
import org.vcell.restclient.Configuration;
import org.vcell.restclient.models.*;
import org.vcell.restclient.api.BioModelResourceApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://vcell.cam.uchc.edu");

        BioModelResourceApi apiInstance = new BioModelResourceApi(defaultClient);
        String bioModelID = "bioModelID_example"; // String | 
        try {
            ApiResponse<BioModel> response = apiInstance.getBioModelWithHttpInfo(bioModelID);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
            System.out.println("Response body: " + response.getData());
        } catch (ApiException e) {
            System.err.println("Exception when calling BioModelResourceApi#getBioModel");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
bioModelID	String

Return type

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

getBioModelSummaries

List getBioModelSummaries(includePublicAndShared)

Return BioModel summaries.

Example

// Import classes:
import org.vcell.restclient.ApiClient;
import org.vcell.restclient.ApiException;
import org.vcell.restclient.Configuration;
import org.vcell.restclient.models.*;
import org.vcell.restclient.api.BioModelResourceApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://vcell.cam.uchc.edu");

        BioModelResourceApi apiInstance = new BioModelResourceApi(defaultClient);
        Boolean includePublicAndShared = true; // Boolean | Includes BioModel summaries that are public or shared with requester. Default is true.
        try {
            List<BioModelSummary> result = apiInstance.getBioModelSummaries(includePublicAndShared);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BioModelResourceApi#getBioModelSummaries");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
includePublicAndShared	Boolean	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	-

getBioModelSummariesWithHttpInfo

ApiResponse<List> getBioModelSummaries getBioModelSummariesWithHttpInfo(includePublicAndShared)

Return BioModel summaries.

Example

// Import classes:
import org.vcell.restclient.ApiClient;
import org.vcell.restclient.ApiException;
import org.vcell.restclient.ApiResponse;
import org.vcell.restclient.Configuration;
import org.vcell.restclient.models.*;
import org.vcell.restclient.api.BioModelResourceApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://vcell.cam.uchc.edu");

        BioModelResourceApi apiInstance = new BioModelResourceApi(defaultClient);
        Boolean includePublicAndShared = true; // Boolean | Includes BioModel summaries that are public or shared with requester. Default is true.
        try {
            ApiResponse<List<BioModelSummary>> response = apiInstance.getBioModelSummariesWithHttpInfo(includePublicAndShared);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
            System.out.println("Response body: " + response.getData());
        } catch (ApiException e) {
            System.err.println("Exception when calling BioModelResourceApi#getBioModelSummaries");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

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

Return type

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

getBioModelSummary

BioModelSummary getBioModelSummary(bioModelID)

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

Example

// Import classes:
import org.vcell.restclient.ApiClient;
import org.vcell.restclient.ApiException;
import org.vcell.restclient.Configuration;
import org.vcell.restclient.models.*;
import org.vcell.restclient.api.BioModelResourceApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://vcell.cam.uchc.edu");

        BioModelResourceApi apiInstance = new BioModelResourceApi(defaultClient);
        String bioModelID = "bioModelID_example"; // String | 
        try {
            BioModelSummary result = apiInstance.getBioModelSummary(bioModelID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BioModelResourceApi#getBioModelSummary");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
bioModelID	String

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	-

getBioModelSummaryWithHttpInfo

ApiResponse getBioModelSummary getBioModelSummaryWithHttpInfo(bioModelID)

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

Example

// Import classes:
import org.vcell.restclient.ApiClient;
import org.vcell.restclient.ApiException;
import org.vcell.restclient.ApiResponse;
import org.vcell.restclient.Configuration;
import org.vcell.restclient.models.*;
import org.vcell.restclient.api.BioModelResourceApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://vcell.cam.uchc.edu");

        BioModelResourceApi apiInstance = new BioModelResourceApi(defaultClient);
        String bioModelID = "bioModelID_example"; // String | 
        try {
            ApiResponse<BioModelSummary> response = apiInstance.getBioModelSummaryWithHttpInfo(bioModelID);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
            System.out.println("Response body: " + response.getData());
        } catch (ApiException e) {
            System.err.println("Exception when calling BioModelResourceApi#getBioModelSummary");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
bioModelID	String

Return type

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

getBioModelVCML

String getBioModelVCML(bioModelID)

Get the BioModel in VCML format.

Example

// Import classes:
import org.vcell.restclient.ApiClient;
import org.vcell.restclient.ApiException;
import org.vcell.restclient.Configuration;
import org.vcell.restclient.models.*;
import org.vcell.restclient.api.BioModelResourceApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://vcell.cam.uchc.edu");

        BioModelResourceApi apiInstance = new BioModelResourceApi(defaultClient);
        String bioModelID = "bioModelID_example"; // String | 
        try {
            String result = apiInstance.getBioModelVCML(bioModelID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BioModelResourceApi#getBioModelVCML");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
bioModelID	String

Return type

String

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	-

getBioModelVCMLWithHttpInfo

ApiResponse getBioModelVCML getBioModelVCMLWithHttpInfo(bioModelID)

Get the BioModel in VCML format.

Example

// Import classes:
import org.vcell.restclient.ApiClient;
import org.vcell.restclient.ApiException;
import org.vcell.restclient.ApiResponse;
import org.vcell.restclient.Configuration;
import org.vcell.restclient.models.*;
import org.vcell.restclient.api.BioModelResourceApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://vcell.cam.uchc.edu");

        BioModelResourceApi apiInstance = new BioModelResourceApi(defaultClient);
        String bioModelID = "bioModelID_example"; // String | 
        try {
            ApiResponse<String> response = apiInstance.getBioModelVCMLWithHttpInfo(bioModelID);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
            System.out.println("Response body: " + response.getData());
        } catch (ApiException e) {
            System.err.println("Exception when calling BioModelResourceApi#getBioModelVCML");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
bioModelID	String

Return type

ApiResponse<**String**>

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	-

saveBioModel

String saveBioModel(body, newName, simsRequiringUpdates)

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

Example

// Import classes:
import org.vcell.restclient.ApiClient;
import org.vcell.restclient.ApiException;
import org.vcell.restclient.Configuration;
import org.vcell.restclient.auth.*;
import org.vcell.restclient.models.*;
import org.vcell.restclient.api.BioModelResourceApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://vcell.cam.uchc.edu");
        

        BioModelResourceApi apiInstance = new BioModelResourceApi(defaultClient);
        String body = "body_example"; // String | BioModelVCML which will be saved.
        String newName = "newName_example"; // String | Name to save new BioModel under. Leave blank if re-saving existing BioModel.
        List<String> simsRequiringUpdates = Arrays.asList(); // List<String> | The name of simulations that will be prepared for future execution.
        try {
            String result = apiInstance.saveBioModel(body, newName, simsRequiringUpdates);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BioModelResourceApi#saveBioModel");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
body	String	BioModelVCML which will be saved.
newName	String	Name to save new BioModel under. Leave blank if re-saving existing BioModel.	[optional]
simsRequiringUpdates	List<String>	The name of simulations that will be prepared for future execution.	[optional]

Return type

String

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	-

saveBioModelWithHttpInfo

ApiResponse saveBioModel saveBioModelWithHttpInfo(body, newName, simsRequiringUpdates)

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

Example

// Import classes:
import org.vcell.restclient.ApiClient;
import org.vcell.restclient.ApiException;
import org.vcell.restclient.ApiResponse;
import org.vcell.restclient.Configuration;
import org.vcell.restclient.auth.*;
import org.vcell.restclient.models.*;
import org.vcell.restclient.api.BioModelResourceApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://vcell.cam.uchc.edu");
        

        BioModelResourceApi apiInstance = new BioModelResourceApi(defaultClient);
        String body = "body_example"; // String | BioModelVCML which will be saved.
        String newName = "newName_example"; // String | Name to save new BioModel under. Leave blank if re-saving existing BioModel.
        List<String> simsRequiringUpdates = Arrays.asList(); // List<String> | The name of simulations that will be prepared for future execution.
        try {
            ApiResponse<String> response = apiInstance.saveBioModelWithHttpInfo(body, newName, simsRequiringUpdates);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
            System.out.println("Response body: " + response.getData());
        } catch (ApiException e) {
            System.err.println("Exception when calling BioModelResourceApi#saveBioModel");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
body	String	BioModelVCML which will be saved.
newName	String	Name to save new BioModel under. Leave blank if re-saving existing BioModel.	[optional]
simsRequiringUpdates	List<String>	The name of simulations that will be prepared for future execution.	[optional]

Return type

ApiResponse<**String**>

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	-