File size: 14,020 Bytes
9d54b72 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 |
# vcell_client.BioModelResourceApi
All URIs are relative to *https://vcell.cam.uchc.edu*
Method | HTTP request | Description
------------- | ------------- | -------------
[**delete_bio_model**](BioModelResourceApi.md#delete_bio_model) | **DELETE** /api/v1/bioModel/{bioModelID} | Delete the BioModel from VCell's database.
[**get_bio_model**](BioModelResourceApi.md#get_bio_model) | **GET** /api/v1/bioModel/{bioModelID} | Get BioModel.
[**get_bio_model_summaries**](BioModelResourceApi.md#get_bio_model_summaries) | **GET** /api/v1/bioModel/summaries | Return BioModel summaries.
[**get_bio_model_summary**](BioModelResourceApi.md#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**](BioModelResourceApi.md#get_bio_model_vcml) | **GET** /api/v1/bioModel/{bioModelID}/vcml_download | Get the BioModel in VCML format.
[**save_bio_model**](BioModelResourceApi.md#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
```python
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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **get_bio_model**
> BioModel get_bio_model(bio_model_id)
Get BioModel.
### Example
```python
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**](BioModel.md)
### 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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **get_bio_model_summaries**
> List[BioModelSummary] get_bio_model_summaries(include_public_and_shared=include_public_and_shared)
Return BioModel summaries.
### Example
```python
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]**](BioModelSummary.md)
### 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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **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
```python
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**](BioModelSummary.md)
### 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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **get_bio_model_vcml**
> str get_bio_model_vcml(bio_model_id)
Get the BioModel in VCML format.
### Example
```python
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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **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
```python
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]**](str.md)| The name of simulations that will be prepared for future execution. | [optional]
### Return type
**str**
### Authorization
[openId](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|