Skip to content

Latest commit

 

History

History
592 lines (417 loc) · 22.6 KB

BRAPIApi.md

File metadata and controls

592 lines (417 loc) · 22.6 KB
Raw

opensilexClientToolsPython.BRAPIApi

All URIs are relative to https://localhost

Method HTTP request Description
get_calls GET /brapi/v1/calls Check the available BrAPI calls
get_germplasm_by_search GET /brapi/v1/germplasm Submit a search request for germplasm (type accession in OpenSILEX
get_observation_units GET /brapi/v1/studies/{studyDbId}/observationunits List all the observation units measured in the study.
get_observation_variables GET /brapi/v1/studies/{studyDbId}/observationvariables List all the observation variables measured in the study.
get_observations GET /brapi/v1/studies/{studyDbId}/observations Get the observations associated to a specific study
get_studies GET /brapi/v1/studies Retrieve studies information
get_studies_search GET /brapi/v1/studies-search Retrieve studies information
get_study_details GET /brapi/v1/studies/{studyDbId} Retrieve study details
get_variable_details GET /brapi/v1/variables/{observationVariableDbId} Retrieve variable details by id
get_variables_list GET /brapi/v1/variables BrAPIv1CallDTO to retrieve a list of observationVariables available in the system

get_calls

BrAPIv1CallListResponse get_calls(page=page, page_size=page_size, data_type=data_type)

Check the available BrAPI calls

Check the available BrAPI calls

Example

from __future__ import print_function
import time
import opensilexClientToolsPython
from opensilexClientToolsPython.rest import ApiException
from pprint import pprint

# create an instance of the API class
pythonClient = opensilexClientToolsPython.ApiClient()
pythonClient.connect_to_opensilex_ws(identifier="guest@opensilex.org",password="guest",host="https://localhost")
api_instance = opensilexClientToolsPython.BRAPIApi(pythonClient)
page = 0 # int | Page number (optional) (default to 0)
page_size = 20 # int | Page size (optional) (default to 20)
data_type = '\"json\"' # str | datatype (optional)


try:
    # Check the available BrAPI calls
    api_response = api_instance.get_calls(page=page, page_size=page_size, data_type=data_type)
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling BRAPIApi->get_calls: %s\n" % e)

Parameters

Name Type Description Notes
page int Page number [optional] [default to 0]
page_size int Page size [optional] [default to 20]
data_type str datatype [optional]

Return type

BrAPIv1CallListResponse

Authorization

No authorization required

HTTP request headers

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

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

get_germplasm_by_search

BrAPIv1GermplasmListResponse get_germplasm_by_search(authorization, germplasm_db_id=germplasm_db_id, germplasm_pui=germplasm_pui, germplasm_name=germplasm_name, common_crop_name=common_crop_name, page=page, page_size=page_size, accept_language=accept_language)

Submit a search request for germplasm (type accession in OpenSILEX

Example

from __future__ import print_function
import time
import opensilexClientToolsPython
from opensilexClientToolsPython.rest import ApiException
from pprint import pprint

# create an instance of the API class
pythonClient = opensilexClientToolsPython.ApiClient()
pythonClient.connect_to_opensilex_ws(identifier="guest@opensilex.org",password="guest",host="https://localhost")
api_instance = opensilexClientToolsPython.BRAPIApi(pythonClient)
germplasm_db_id = 'germplasm_db_id_example' # str | Search by germplasmDbId (URI of an OpenSilex accession) (optional)
germplasm_pui = 'germplasm_pui_example' # str | Search by germplasmPUI (URI of an OpenSilex accession) (optional)
germplasm_name = 'germplasm_name_example' # str | Search by germplasmName (name of an OpenSilex accession) (optional)
common_crop_name = 'common_crop_name_example' # str | Search by commonCropName (name of the species of an OpenSilex accession) (optional)
page = 0 # int | Page number (optional) (default to 0)
page_size = 20 # int | Page size (optional) (default to 20)


try:
    # Submit a search request for germplasm (type accession in OpenSILEX
    api_response = api_instance.get_germplasm_by_search(germplasm_db_id=germplasm_db_id, germplasm_pui=germplasm_pui, germplasm_name=germplasm_name, common_crop_name=common_crop_name, page=page, page_size=page_size, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling BRAPIApi->get_germplasm_by_search: %s\n" % e)

Parameters

Name Type Description Notes
germplasm_db_id str Search by germplasmDbId (URI of an OpenSilex accession) [optional]
germplasm_pui str Search by germplasmPUI (URI of an OpenSilex accession) [optional]
germplasm_name str Search by germplasmName (name of an OpenSilex accession) [optional]
common_crop_name str Search by commonCropName (name of the species of an OpenSilex accession) [optional]
page int Page number [optional] [default to 0]
page_size int Page size [optional] [default to 20]

Return type

BrAPIv1GermplasmListResponse

Authorization

No authorization required

HTTP request headers

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

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

get_observation_units

BrAPIv1ObservationUnitListResponse get_observation_units(study_db_id, authorization, observation_level=observation_level, page_size=page_size, page=page, accept_language=accept_language)

List all the observation units measured in the study.

List all the observation units measured in the study.

Example

from __future__ import print_function
import time
import opensilexClientToolsPython
from opensilexClientToolsPython.rest import ApiException
from pprint import pprint

# create an instance of the API class
pythonClient = opensilexClientToolsPython.ApiClient()
pythonClient.connect_to_opensilex_ws(identifier="guest@opensilex.org",password="guest",host="https://localhost")
api_instance = opensilexClientToolsPython.BRAPIApi(pythonClient)
study_db_id = 'study_db_id_example' # str | studyDbId
observation_level = '\"Plot\"' # str | observationLevel (optional)
page_size = 20 # int | pageSize (optional) (default to 20)
page = 0 # int | page (optional) (default to 0)


try:
    # List all the observation units measured in the study.
    api_response = api_instance.get_observation_units(study_db_id, observation_level=observation_level, page_size=page_size, page=page, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling BRAPIApi->get_observation_units: %s\n" % e)

Parameters

Name Type Description Notes
study_db_id str studyDbId
observation_level str observationLevel [optional]
page_size int pageSize [optional] [default to 20]
page int page [optional] [default to 0]

Return type

BrAPIv1ObservationUnitListResponse

Authorization

No authorization required

HTTP request headers

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

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

get_observation_variables

BrAPIv1ObservationVariableListResponse get_observation_variables(study_db_id, authorization, page_size=page_size, page=page, accept_language=accept_language)

List all the observation variables measured in the study.

List all the observation variables measured in the study.

Example

from __future__ import print_function
import time
import opensilexClientToolsPython
from opensilexClientToolsPython.rest import ApiException
from pprint import pprint

# create an instance of the API class
pythonClient = opensilexClientToolsPython.ApiClient()
pythonClient.connect_to_opensilex_ws(identifier="guest@opensilex.org",password="guest",host="https://localhost")
api_instance = opensilexClientToolsPython.BRAPIApi(pythonClient)
study_db_id = 'study_db_id_example' # str | studyDbId
page_size = 20 # int | pageSize (optional) (default to 20)
page = 0 # int | page (optional) (default to 0)


try:
    # List all the observation variables measured in the study.
    api_response = api_instance.get_observation_variables(study_db_id, page_size=page_size, page=page, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling BRAPIApi->get_observation_variables: %s\n" % e)

Parameters

Name Type Description Notes
study_db_id str studyDbId
page_size int pageSize [optional] [default to 20]
page int page [optional] [default to 0]

Return type

BrAPIv1ObservationVariableListResponse

Authorization

No authorization required

HTTP request headers

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

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

get_observations

BrAPIv1ObservationListResponse get_observations(study_db_id, authorization, observation_variable_db_ids=observation_variable_db_ids, page_size=page_size, page=page, accept_language=accept_language)

Get the observations associated to a specific study

Get the observations associated to a specific study

Example

from __future__ import print_function
import time
import opensilexClientToolsPython
from opensilexClientToolsPython.rest import ApiException
from pprint import pprint

# create an instance of the API class
pythonClient = opensilexClientToolsPython.ApiClient()
pythonClient.connect_to_opensilex_ws(identifier="guest@opensilex.org",password="guest",host="https://localhost")
api_instance = opensilexClientToolsPython.BRAPIApi(pythonClient)
study_db_id = 'study_db_id_example' # str | studyDbId
observation_variable_db_ids = ['observation_variable_db_ids_example'] # list[str] | observationVariableDbIds (optional)
page_size = 20 # int | pageSize (optional) (default to 20)
page = 0 # int | page (optional) (default to 0)


try:
    # Get the observations associated to a specific study
    api_response = api_instance.get_observations(study_db_id, observation_variable_db_ids=observation_variable_db_ids, page_size=page_size, page=page, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling BRAPIApi->get_observations: %s\n" % e)

Parameters

Name Type Description Notes
study_db_id str studyDbId
observation_variable_db_ids list[str] observationVariableDbIds [optional]
page_size int pageSize [optional] [default to 20]
page int page [optional] [default to 0]

Return type

BrAPIv1ObservationListResponse

Authorization

No authorization required

HTTP request headers

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

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

get_studies

BrAPIv1StudyListResponse get_studies(authorization, study_db_id=study_db_id, active=active, sort_by=sort_by, sort_order=sort_order, page=page, page_size=page_size, accept_language=accept_language)

Retrieve studies information

Retrieve studies information

Example

from __future__ import print_function
import time
import opensilexClientToolsPython
from opensilexClientToolsPython.rest import ApiException
from pprint import pprint

# create an instance of the API class
pythonClient = opensilexClientToolsPython.ApiClient()
pythonClient.connect_to_opensilex_ws(identifier="guest@opensilex.org",password="guest",host="https://localhost")
api_instance = opensilexClientToolsPython.BRAPIApi(pythonClient)
study_db_id = 'study_db_id_example' # str | Search by studyDbId (optional)
active = 'active_example' # str | Filter active status true/false (optional)
sort_by = 'sort_by_example' # str | Name of the field to sort by: studyDbId, active (optional)
sort_order = 'sort_order_example' # str | Sort order direction - ASC or DESC (optional)
page = 0 # int | Page number (optional) (default to 0)
page_size = 20 # int | Page size (optional) (default to 20)


try:
    # Retrieve studies information
    api_response = api_instance.get_studies(study_db_id=study_db_id, active=active, sort_by=sort_by, sort_order=sort_order, page=page, page_size=page_size, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling BRAPIApi->get_studies: %s\n" % e)

Parameters

Name Type Description Notes
study_db_id str Search by studyDbId [optional]
active str Filter active status true/false [optional]
sort_by str Name of the field to sort by: studyDbId, active [optional]
sort_order str Sort order direction - ASC or DESC [optional]
page int Page number [optional] [default to 0]
page_size int Page size [optional] [default to 20]

Return type

BrAPIv1StudyListResponse

Authorization

No authorization required

HTTP request headers

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

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

get_studies_search

BrAPIv1StudyListResponse get_studies_search(authorization, study_db_id=study_db_id, active=active, sort_by=sort_by, sort_order=sort_order, page_size=page_size, page=page, accept_language=accept_language)

Retrieve studies information

Retrieve studies information

Example

from __future__ import print_function
import time
import opensilexClientToolsPython
from opensilexClientToolsPython.rest import ApiException
from pprint import pprint

# create an instance of the API class
pythonClient = opensilexClientToolsPython.ApiClient()
pythonClient.connect_to_opensilex_ws(identifier="guest@opensilex.org",password="guest",host="https://localhost")
api_instance = opensilexClientToolsPython.BRAPIApi(pythonClient)
study_db_id = 'study_db_id_example' # str | Search by studyDbId (optional)
active = 'active_example' # str | Filter active status true/false (optional)
sort_by = 'sort_by_example' # str | Name of the field to sort by: studyDbId or seasonDbId (optional)
sort_order = 'sort_order_example' # str | Sort order direction - ASC or DESC (optional)
page_size = 20 # int | pageSize (optional) (default to 20)
page = 0 # int | page (optional) (default to 0)


try:
    # Retrieve studies information
    api_response = api_instance.get_studies_search(study_db_id=study_db_id, active=active, sort_by=sort_by, sort_order=sort_order, page_size=page_size, page=page, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling BRAPIApi->get_studies_search: %s\n" % e)

Parameters

Name Type Description Notes
study_db_id str Search by studyDbId [optional]
active str Filter active status true/false [optional]
sort_by str Name of the field to sort by: studyDbId or seasonDbId [optional]
sort_order str Sort order direction - ASC or DESC [optional]
page_size int pageSize [optional] [default to 20]
page int page [optional] [default to 0]

Return type

BrAPIv1StudyListResponse

Authorization

No authorization required

HTTP request headers

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

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

get_study_details

BrAPIv1SingleStudyResponse get_study_details(study_db_id, authorization, accept_language=accept_language)

Retrieve study details

Retrieve study details

Example

from __future__ import print_function
import time
import opensilexClientToolsPython
from opensilexClientToolsPython.rest import ApiException
from pprint import pprint

# create an instance of the API class
pythonClient = opensilexClientToolsPython.ApiClient()
pythonClient.connect_to_opensilex_ws(identifier="guest@opensilex.org",password="guest",host="https://localhost")
api_instance = opensilexClientToolsPython.BRAPIApi(pythonClient)
study_db_id = 'study_db_id_example' # str | Search by studyDbId


try:
    # Retrieve study details
    api_response = api_instance.get_study_details(study_db_id, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling BRAPIApi->get_study_details: %s\n" % e)

Parameters

Name Type Description Notes
study_db_id str Search by studyDbId

Return type

BrAPIv1SingleStudyResponse

Authorization

No authorization required

HTTP request headers

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

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

get_variable_details

BrAPIv1SingleObservationVariableResponse get_variable_details(observation_variable_db_id, authorization, accept_language=accept_language)

Retrieve variable details by id

Retrieve variable details by id

Example

from __future__ import print_function
import time
import opensilexClientToolsPython
from opensilexClientToolsPython.rest import ApiException
from pprint import pprint

# create an instance of the API class
pythonClient = opensilexClientToolsPython.ApiClient()
pythonClient.connect_to_opensilex_ws(identifier="guest@opensilex.org",password="guest",host="https://localhost")
api_instance = opensilexClientToolsPython.BRAPIApi(pythonClient)
observation_variable_db_id = 'observation_variable_db_id_example' # str | A variable URI (Unique Resource Identifier)


try:
    # Retrieve variable details by id
    api_response = api_instance.get_variable_details(observation_variable_db_id, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling BRAPIApi->get_variable_details: %s\n" % e)

Parameters

Name Type Description Notes
observation_variable_db_id str A variable URI (Unique Resource Identifier)

Return type

BrAPIv1SingleObservationVariableResponse

Authorization

No authorization required

HTTP request headers

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

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

get_variables_list

BrAPIv1ObservationVariableListResponse get_variables_list(authorization, observation_variable_db_id=observation_variable_db_id, page_size=page_size, page=page, accept_language=accept_language)

BrAPIv1CallDTO to retrieve a list of observationVariables available in the system

retrieve variables information

Example

from __future__ import print_function
import time
import opensilexClientToolsPython
from opensilexClientToolsPython.rest import ApiException
from pprint import pprint

# create an instance of the API class
pythonClient = opensilexClientToolsPython.ApiClient()
pythonClient.connect_to_opensilex_ws(identifier="guest@opensilex.org",password="guest",host="https://localhost")
api_instance = opensilexClientToolsPython.BRAPIApi(pythonClient)
observation_variable_db_id = 'observation_variable_db_id_example' # str | observationVariableDbId (optional)
page_size = 20 # int | pageSize (optional) (default to 20)
page = 0 # int | page (optional) (default to 0)


try:
    # BrAPIv1CallDTO to retrieve a list of observationVariables available in the system
    api_response = api_instance.get_variables_list(observation_variable_db_id=observation_variable_db_id, page_size=page_size, page=page, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling BRAPIApi->get_variables_list: %s\n" % e)

Parameters

Name Type Description Notes
observation_variable_db_id str observationVariableDbId [optional]
page_size int pageSize [optional] [default to 20]
page int page [optional] [default to 0]

Return type

BrAPIv1ObservationVariableListResponse

Authorization

No authorization required

HTTP request headers

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

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