mm_power_sdk_python.InstitutionsApi
All URIs are relative to https://api.molecularmatch.com/v4
Method | HTTP request | Description |
---|---|---|
delete_institution | DELETE /institution/{id} | Delete an institution |
delete_private_trial | DELETE /institution/{id}/trial/{trialId} | Delete a private trial |
get_institution | GET /institution/{id} | Get an institution |
get_institution_status | GET /institution/{id}/status | Get an institution record's status |
get_institutions | GET /institutions | Get a paginated list of institutions |
get_private_trial | GET /institution/{id}/trial/{trialId} | Get a private trial |
get_private_trial_status | GET /institution/{id}/trial/{trialId}/status | Get a private trial record's status |
get_private_trials | GET /institution/{id}/trials | Get a paginated list of private |
post_institution | POST /institution | Create an institution |
post_private_trial | POST /institution/{id}/trial | Create a private trial |
put_institution | PUT /institution/{id} | Put/Update an institution |
put_private_trial | PUT /institution/{id}/trial/{trialId} | Put/Update a private trial |
delete_institution
Institution delete_institution(id)
Delete an institution
Delete an institution
Example
from __future__ import print_function
import time
import mm_power_sdk_python
from mm_power_sdk_python.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = mm_power_sdk_python.InstitutionsApi(mm_power_sdk_python.ApiClient(configuration))
id = 'id_example' # str | ID of the Institution to delete
try:
# Delete an institution
api_response = api_instance.delete_institution(id)
pprint(api_response)
except ApiException as e:
print("Exception when calling InstitutionsApi->delete_institution: %s\n" % e)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
id | str | ID of the Institution to delete |
Return type
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
delete_private_trial
PrivateTrial delete_private_trial(id, trial_id)
Delete a private trial
Delete a private trial
Example
from __future__ import print_function
import time
import mm_power_sdk_python
from mm_power_sdk_python.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = mm_power_sdk_python.InstitutionsApi(mm_power_sdk_python.ApiClient(configuration))
id = 'id_example' # str | ID of the Institution governing the private trial
trial_id = 'trial_id_example' # str | ID of the private trial to delete
try:
# Delete a private trial
api_response = api_instance.delete_private_trial(id, trial_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling InstitutionsApi->delete_private_trial: %s\n" % e)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
id | str | ID of the Institution governing the private trial | |
trial_id | str | ID of the private trial to delete |
Return type
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
get_institution
Institution get_institution(id)
Get an institution
Get an institution
Example
from __future__ import print_function
import time
import mm_power_sdk_python
from mm_power_sdk_python.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = mm_power_sdk_python.InstitutionsApi(mm_power_sdk_python.ApiClient(configuration))
id = 'id_example' # str | ID of the Institution to return
try:
# Get an institution
api_response = api_instance.get_institution(id)
pprint(api_response)
except ApiException as e:
print("Exception when calling InstitutionsApi->get_institution: %s\n" % e)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
id | str | ID of the Institution to return |
Return type
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
get_institution_status
Institution get_institution_status(id)
Get an institution record's status
Get an institution status
Example
from __future__ import print_function
import time
import mm_power_sdk_python
from mm_power_sdk_python.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = mm_power_sdk_python.InstitutionsApi(mm_power_sdk_python.ApiClient(configuration))
id = 'id_example' # str | ID of the Institution to return status for
try:
# Get an institution record's status
api_response = api_instance.get_institution_status(id)
pprint(api_response)
except ApiException as e:
print("Exception when calling InstitutionsApi->get_institution_status: %s\n" % e)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
id | str | ID of the Institution to return status for |
Return type
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
get_institutions
Institution get_institutions()
Get a paginated list of institutions
Example
from __future__ import print_function
import time
import mm_power_sdk_python
from mm_power_sdk_python.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = mm_power_sdk_python.InstitutionsApi(mm_power_sdk_python.ApiClient(configuration))
try:
# Get a paginated list of institutions
api_response = api_instance.get_institutions()
pprint(api_response)
except ApiException as e:
print("Exception when calling InstitutionsApi->get_institutions: %s\n" % e)
Parameters
This endpoint does not need any parameter.
Return type
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
get_private_trial
PrivateTrial get_private_trial(id, trial_id)
Get a private trial
Get a private trial
Example
from __future__ import print_function
import time
import mm_power_sdk_python
from mm_power_sdk_python.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = mm_power_sdk_python.InstitutionsApi(mm_power_sdk_python.ApiClient(configuration))
id = 'id_example' # str | ID of the Institution governing the private trial
trial_id = 'trial_id_example' # str | ID of the private trial to return
try:
# Get a private trial
api_response = api_instance.get_private_trial(id, trial_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling InstitutionsApi->get_private_trial: %s\n" % e)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
id | str | ID of the Institution governing the private trial | |
trial_id | str | ID of the private trial to return |
Return type
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
get_private_trial_status
PrivateTrial get_private_trial_status(id, trial_id)
Get a private trial record's status
Get a private trial's status
Example
from __future__ import print_function
import time
import mm_power_sdk_python
from mm_power_sdk_python.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = mm_power_sdk_python.InstitutionsApi(mm_power_sdk_python.ApiClient(configuration))
id = 'id_example' # str | ID of the Institution governing the private trial
trial_id = 'trial_id_example' # str | ID of the private trial to return status for
try:
# Get a private trial record's status
api_response = api_instance.get_private_trial_status(id, trial_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling InstitutionsApi->get_private_trial_status: %s\n" % e)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
id | str | ID of the Institution governing the private trial | |
trial_id | str | ID of the private trial to return status for |
Return type
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
get_private_trials
PrivateTrial get_private_trials(id)
Get a paginated list of private
Example
from __future__ import print_function
import time
import mm_power_sdk_python
from mm_power_sdk_python.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = mm_power_sdk_python.InstitutionsApi(mm_power_sdk_python.ApiClient(configuration))
id = 'id_example' # str | ID of the Institution governing the private trial
try:
# Get a paginated list of private
api_response = api_instance.get_private_trials(id)
pprint(api_response)
except ApiException as e:
print("Exception when calling InstitutionsApi->get_private_trials: %s\n" % e)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
id | str | ID of the Institution governing the private trial |
Return type
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
post_institution
Institution post_institution(body)
Create an institution
Example
from __future__ import print_function
import time
import mm_power_sdk_python
from mm_power_sdk_python.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = mm_power_sdk_python.InstitutionsApi(mm_power_sdk_python.ApiClient(configuration))
body = mm_power_sdk_python.Institution() # Institution | Institution object to send to MolecularMatch for processing
try:
# Create an institution
api_response = api_instance.post_institution(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling InstitutionsApi->post_institution: %s\n" % e)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
body | Institution | Institution object to send to MolecularMatch for processing |
Return type
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_private_trial
PrivateTrial post_private_trial(body)
Create a private trial
Example
from __future__ import print_function
import time
import mm_power_sdk_python
from mm_power_sdk_python.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = mm_power_sdk_python.InstitutionsApi(mm_power_sdk_python.ApiClient(configuration))
body = mm_power_sdk_python.PrivateTrial() # PrivateTrial | Private Trial object to send to MolecularMatch for processing
try:
# Create a private trial
api_response = api_instance.post_private_trial(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling InstitutionsApi->post_private_trial: %s\n" % e)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
body | PrivateTrial | Private Trial object to send to MolecularMatch for processing |
Return type
HTTP request headers
- Content-Type: application/json
- Accept: application/json
put_institution
Institution put_institution(id)
Put/Update an institution
Put an institution
Example
from __future__ import print_function
import time
import mm_power_sdk_python
from mm_power_sdk_python.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = mm_power_sdk_python.InstitutionsApi(mm_power_sdk_python.ApiClient(configuration))
id = 'id_example' # str | ID of the Institution to return
try:
# Put/Update an institution
api_response = api_instance.put_institution(id)
pprint(api_response)
except ApiException as e:
print("Exception when calling InstitutionsApi->put_institution: %s\n" % e)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
id | str | ID of the Institution to return |
Return type
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
put_private_trial
PrivateTrial put_private_trial(id, trial_id)
Put/Update a private trial
Put a private trial
Example
from __future__ import print_function
import time
import mm_power_sdk_python
from mm_power_sdk_python.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = mm_power_sdk_python.InstitutionsApi(mm_power_sdk_python.ApiClient(configuration))
id = 'id_example' # str | ID of the Institution governing the private trial
trial_id = 'trial_id_example' # str | ID of the private trial
try:
# Put/Update a private trial
api_response = api_instance.put_private_trial(id, trial_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling InstitutionsApi->put_private_trial: %s\n" % e)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
id | str | ID of the Institution governing the private trial | |
trial_id | str | ID of the private trial |
Return type
HTTP request headers
- Content-Type: Not defined
- Accept: application/json