opensilexClientToolsPython.ScientificObjectsApi

All URIs are relative to https://localhost

Method	HTTP request	Description
count_scientific_objects	GET /core/scientific_objects/count	Count scientific objects
create_scientific_object	POST /core/scientific_objects	Create a scientific object for the given experiment
delete_scientific_object	DELETE /core/scientific_objects/{uri}	Delete a scientific object
export_csv	POST /core/scientific_objects/export	Export a given list of scientific object URIs to csv data file
export_geospatial2	POST /core/scientific_objects/export_geospatial	Export a given list of scientific object URIs to shapefile or geojson
get_scientific_object_data_files_provenances	GET /core/scientific_objects/{uri}/datafiles/provenances	Get provenances of datafiles linked to this scientific object
get_scientific_object_data_provenances	GET /core/scientific_objects/{uri}/data/provenances	Get provenances of data that have been measured on this scientific object
get_scientific_object_detail	GET /core/scientific_objects/{uri}	Get scientific object detail
get_scientific_object_detail_by_experiments	GET /core/scientific_objects/{uri}/experiments	Get scientific object detail for each experiments, a null value for experiment in response means a properties defined outside of any experiment (shared object).
get_scientific_object_variables	GET /core/scientific_objects/{uri}/variables	Get variables measured on this scientific object
get_scientific_objects_children	GET /core/scientific_objects/children	Get list of scientific object children
get_scientific_objects_list_by_uris	POST /core/scientific_objects/by_uris	Get scientific objet list of a given experiment URI
get_used_types	GET /core/scientific_objects/used_types	get used scientific object types
import_csv1	POST /core/scientific_objects/import	Import a CSV file for the given experiment URI and scientific object type.
search_scientific_objects	GET /core/scientific_objects	Search list of scientific objects
search_scientific_objects_with_geometry_list_by_uris	GET /core/scientific_objects/geometry	Get scientific objet list with geometry of a given experiment URI
update_scientific_object	PUT /core/scientific_objects	Update a scientific object for the given experiment
validate_csv3	POST /core/scientific_objects/import_validation	Validate a CSV file for the given experiment URI and scientific object type.

count_scientific_objects

int count_scientific_objects(authorization, experiment=experiment, accept_language=accept_language)

Count scientific objects

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.ScientificObjectsApi(pythonClient)
experiment = 'http://www.opensilex.org/demo/2018/o18000076' # str | Experiment URI (optional)


try:
    # Count scientific objects
    api_response = api_instance.count_scientific_objects(experiment=experiment, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling ScientificObjectsApi->count_scientific_objects: %s\n" % e)

Parameters

Name	Type	Description	Notes
experiment	str	Experiment URI	[optional]

Return type

int

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

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

create_scientific_object

str create_scientific_object(body, authorization, accept_language=accept_language)

Create a scientific object for the given experiment

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.ScientificObjectsApi(pythonClient)
body = opensilexClientToolsPython.ScientificObjectCreationDTO() # ScientificObjectCreationDTO | Scientific object description


try:
    # Create a scientific object for the given experiment
    api_response = api_instance.create_scientific_object(body, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling ScientificObjectsApi->create_scientific_object: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	ScientificObjectCreationDTO	Scientific object description

Return type

str

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

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

delete_scientific_object

str delete_scientific_object(uri, authorization, experiment=experiment, accept_language=accept_language)

Delete a scientific object

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.ScientificObjectsApi(pythonClient)
uri = 'http://opensilex.org/id/Plot 12' # str | scientific object URI
experiment = 'http://opensilex/experiment/id/ZA17' # str | Experiment URI (optional)


try:
    # Delete a scientific object
    api_response = api_instance.delete_scientific_object(uri, experiment=experiment, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling ScientificObjectsApi->delete_scientific_object: %s\n" % e)

Parameters

Name	Type	Description	Notes
uri	str	scientific object URI
experiment	str	Experiment URI	[optional]

Return type

str

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

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

export_csv

export_csv(authorization, body=body, accept_language=accept_language)

Export a given list of scientific object URIs to csv data file

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.ScientificObjectsApi(pythonClient)
body = opensilexClientToolsPython.ScientificObjectExportDTO() # ScientificObjectExportDTO | CSV export configuration (optional)


try:
    # Export a given list of scientific object URIs to csv data file
    api_instance.export_csv(body=body, )
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling ScientificObjectsApi->export_csv: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	ScientificObjectExportDTO	CSV export configuration	[optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/octet-stream

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

export_geospatial2

export_geospatial2(authorization, body=body, experiment=experiment, selected_props=selected_props, format=format, page_size=page_size, accept_language=accept_language)

Export a given list of scientific object URIs to shapefile or geojson

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.ScientificObjectsApi(pythonClient)
body = [opensilexClientToolsPython.GeometryDTO()] # list[GeometryDTO] | Scientific objects (optional)
experiment = 'http://opensilex/experiment/id/ZA17' # str | Experiment URI (optional)
selected_props = ['test'] # list[str] | properties selected (optional)
format = 'shp' # str | export format (shp/geojson) (optional)
page_size = 10000 # int | Page size limited to 10,000 objects (optional)


try:
    # Export a given list of scientific object URIs to shapefile or geojson
    api_instance.export_geospatial2(body=body, experiment=experiment, selected_props=selected_props, format=format, page_size=page_size, )
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling ScientificObjectsApi->export_geospatial2: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	list[GeometryDTO]	Scientific objects	[optional]
experiment	str	Experiment URI	[optional]
selected_props	list[str]	properties selected	[optional]
format	str	export format (shp/geojson)	[optional]
page_size	int	Page size limited to 10,000 objects	[optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/octet-stream

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

get_scientific_object_data_files_provenances

list[ProvenanceGetDTO] get_scientific_object_data_files_provenances(uri, authorization, accept_language=accept_language)

Get provenances of datafiles linked to this scientific object

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.ScientificObjectsApi(pythonClient)
uri = 'http://opensilex.org/id/Plot 12' # str | Scientific Object URI


try:
    # Get provenances of datafiles linked to this scientific object
    api_response = api_instance.get_scientific_object_data_files_provenances(uri, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling ScientificObjectsApi->get_scientific_object_data_files_provenances: %s\n" % e)

Parameters

Name	Type	Description	Notes
uri	str	Scientific Object URI

Return type

list[ProvenanceGetDTO]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

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

get_scientific_object_data_provenances

list[ProvenanceGetDTO] get_scientific_object_data_provenances(uri, authorization, accept_language=accept_language)

Get provenances of data that have been measured on this scientific object

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.ScientificObjectsApi(pythonClient)
uri = 'http://opensilex.org/id/Plot 12' # str | Scientific Object URI


try:
    # Get provenances of data that have been measured on this scientific object
    api_response = api_instance.get_scientific_object_data_provenances(uri, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling ScientificObjectsApi->get_scientific_object_data_provenances: %s\n" % e)

Parameters

Name	Type	Description	Notes
uri	str	Scientific Object URI

Return type

list[ProvenanceGetDTO]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

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

get_scientific_object_detail

ScientificObjectDetailDTO get_scientific_object_detail(uri, authorization, experiment=experiment, accept_language=accept_language)

Get scientific object detail

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.ScientificObjectsApi(pythonClient)
uri = 'http://opensilex.org/set/scientific-objects/so-1357dz_pg_34zm4384wwveg_323_37arch2017-03-30' # str | scientific object URI
experiment = 'http://opensilex.org/set/experiments/21ik1_cims-on' # str | Experiment URI (optional)


try:
    # Get scientific object detail
    api_response = api_instance.get_scientific_object_detail(uri, experiment=experiment, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling ScientificObjectsApi->get_scientific_object_detail: %s\n" % e)

Parameters

Name	Type	Description	Notes
uri	str	scientific object URI
experiment	str	Experiment URI	[optional]

Return type

ScientificObjectDetailDTO

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

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

get_scientific_object_detail_by_experiments

list[ScientificObjectDetailByExperimentsDTO] get_scientific_object_detail_by_experiments(uri, authorization, accept_language=accept_language)

Get scientific object detail for each experiments, a null value for experiment in response means a properties defined outside of any experiment (shared object).

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.ScientificObjectsApi(pythonClient)
uri = 'http://opensilex.org/id/Plot 12' # str | scientific object URI


try:
    # Get scientific object detail for each experiments, a null value for experiment in response means a properties defined outside of any experiment (shared object).
    api_response = api_instance.get_scientific_object_detail_by_experiments(uri, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling ScientificObjectsApi->get_scientific_object_detail_by_experiments: %s\n" % e)

Parameters

Name	Type	Description	Notes
uri	str	scientific object URI

Return type

list[ScientificObjectDetailByExperimentsDTO]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

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

get_scientific_object_variables

list[NamedResourceDTO] get_scientific_object_variables(uri, authorization, accept_language=accept_language)

Get variables measured on this scientific object

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.ScientificObjectsApi(pythonClient)
uri = 'http://opensilex.org/id/Plot 12' # str | Scientific Object URI


try:
    # Get variables measured on this scientific object
    api_response = api_instance.get_scientific_object_variables(uri, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling ScientificObjectsApi->get_scientific_object_variables: %s\n" % e)

Parameters

Name	Type	Description	Notes
uri	str	Scientific Object URI

Return type

list[NamedResourceDTO]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

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

get_scientific_objects_children

list[ScientificObjectNodeWithChildrenDTO] get_scientific_objects_children(authorization, parent=parent, experiment=experiment, rdf_types=rdf_types, name=name, factor_levels=factor_levels, facility=facility, order_by=order_by, page=page, page_size=page_size, accept_language=accept_language)

Get list of scientific object children

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.ScientificObjectsApi(pythonClient)
parent = 'http://opensilex.org/id/Plot 12' # str | Parent object URI (optional)
experiment = 'http://opensilex/experiment/id/ZA17' # str | Experiment URI (optional)
rdf_types = ['vocabulary:Plant'] # list[str] | RDF type filter (optional)
name = '.*' # str | Regex pattern for filtering by name (optional) (default to .*)
factor_levels = ['vocabulary:IrrigationStress'] # list[str] | Factor levels URI (optional)
facility = 'diaphen:serre-2' # str | Facility (optional)
order_by = ['name=asc'] # list[str] | List of fields to sort as an array of fieldName=asc|desc (optional)
page = 0 # int | Page number (optional) (default to 0)
page_size = 20 # int | Page size (optional) (default to 20)


try:
    # Get list of scientific object children
    api_response = api_instance.get_scientific_objects_children(parent=parent, experiment=experiment, rdf_types=rdf_types, name=name, factor_levels=factor_levels, facility=facility, order_by=order_by, page=page, page_size=page_size, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling ScientificObjectsApi->get_scientific_objects_children: %s\n" % e)

Parameters

Name	Type	Description	Notes
parent	str	Parent object URI	[optional]
experiment	str	Experiment URI	[optional]
rdf_types	list[str]	RDF type filter	[optional]
name	str	Regex pattern for filtering by name	[optional] [default to .*]
factor_levels	list[str]	Factor levels URI	[optional]
facility	str	Facility	[optional]
order_by	list[str]	List of fields to sort as an array of fieldName=asc	desc
page	int	Page number	[optional] [default to 0]
page_size	int	Page size	[optional] [default to 20]

Return type

list[ScientificObjectNodeWithChildrenDTO]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

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

get_scientific_objects_list_by_uris

list[ScientificObjectNodeDTO] get_scientific_objects_list_by_uris(authorization, experiment=experiment, body=body, accept_language=accept_language)

Get scientific objet list of a given experiment URI

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.ScientificObjectsApi(pythonClient)
experiment = 'http://opensilex/experiment/id/ZA17' # str | Experiment URI (optional)
body = [opensilexClientToolsPython.list[str]()] # list[str] | Scientific object uris (optional)


try:
    # Get scientific objet list of a given experiment URI
    api_response = api_instance.get_scientific_objects_list_by_uris(experiment=experiment, body=body, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling ScientificObjectsApi->get_scientific_objects_list_by_uris: %s\n" % e)

Parameters

Name	Type	Description	Notes
experiment	str	Experiment URI	[optional]
body	list[str]	Scientific object uris	[optional]

Return type

list[ScientificObjectNodeDTO]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

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

get_used_types

list[ListItemDTO] get_used_types(authorization, experiment=experiment, accept_language=accept_language)

get used scientific object types

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.ScientificObjectsApi(pythonClient)
experiment = 'http://opensilex/experiment/id/ZA17' # str | Experiment URI (optional)


try:
    # get used scientific object types
    api_response = api_instance.get_used_types(experiment=experiment, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling ScientificObjectsApi->get_used_types: %s\n" % e)

Parameters

Name	Type	Description	Notes
experiment	str	Experiment URI	[optional]

Return type

list[ListItemDTO]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

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

import_csv1

CSVValidationDTO import_csv1(description, file, authorization, accept_language=accept_language)

Import a CSV file for the given experiment URI and scientific object type.

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.ScientificObjectsApi(pythonClient)
description = 'description_example' # str | File description with metadata
file = '/path/to/file.txt' # file | Data file


try:
    # Import a CSV file for the given experiment URI and scientific object type.
    api_response = api_instance.import_csv1(description, file, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling ScientificObjectsApi->import_csv1: %s\n" % e)

Parameters

Name	Type	Description	Notes
description	str	File description with metadata
file	file	Data file

Return type

CSVValidationDTO

Authorization

No authorization required

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

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

search_scientific_objects

list[ScientificObjectNodeDTO] search_scientific_objects(authorization, experiment=experiment, rdf_types=rdf_types, name=name, parent=parent, germplasms=germplasms, factor_levels=factor_levels, facility=facility, variables=variables, devices=devices, existence_date=existence_date, creation_date=creation_date, criteria_on_data=criteria_on_data, order_by=order_by, page=page, page_size=page_size, accept_language=accept_language)

Search list of scientific objects

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.ScientificObjectsApi(pythonClient)
experiment = 'http://opensilex/experiment/id/ZA17' # str | Experiment URI (optional)
rdf_types = ['vocabulary:Plant'] # list[str] | RDF type filter (optional)
name = '.*' # str | Regex pattern for filtering by name (optional) (default to .*)
parent = 'http://opensilex.org/id/Plot 12' # str | Parent URI (optional)
germplasms = ['http://aims.fao.org/aos/agrovoc/c_1066'] # list[str] | Germplasm URIs (optional)
factor_levels = ['vocabulary:IrrigationStress'] # list[str] | Factor levels URI (optional)
facility = 'diaphen:serre-2' # str | Facility (optional)
variables = ['variables_example'] # list[str] | Variables URI (optional)
devices = ['devices_example'] # list[str] | Devices URI (optional)
existence_date = '2013-10-20' # date | Date to filter object existence (optional)
creation_date = '2013-10-20' # date | Date to filter object creation (optional)
criteria_on_data = 'criteria_on_data_example' # str | A CriteriaDTO to be applied to data, retain objects that are targets in returned data (optional)
order_by = ['uri=asc'] # list[str] | List of fields to sort as an array of fieldName=asc|desc (optional)
page = 0 # int | Page number (optional) (default to 0)
page_size = 20 # int | Page size (optional) (default to 20)


try:
    # Search list of scientific objects
    api_response = api_instance.search_scientific_objects(experiment=experiment, rdf_types=rdf_types, name=name, parent=parent, germplasms=germplasms, factor_levels=factor_levels, facility=facility, variables=variables, devices=devices, existence_date=existence_date, creation_date=creation_date, criteria_on_data=criteria_on_data, order_by=order_by, page=page, page_size=page_size, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling ScientificObjectsApi->search_scientific_objects: %s\n" % e)

Parameters

Name	Type	Description	Notes
experiment	str	Experiment URI	[optional]
rdf_types	list[str]	RDF type filter	[optional]
name	str	Regex pattern for filtering by name	[optional] [default to .*]
parent	str	Parent URI	[optional]
germplasms	list[str]	Germplasm URIs	[optional]
factor_levels	list[str]	Factor levels URI	[optional]
facility	str	Facility	[optional]
variables	list[str]	Variables URI	[optional]
devices	list[str]	Devices URI	[optional]
existence_date	date	Date to filter object existence	[optional]
creation_date	date	Date to filter object creation	[optional]
criteria_on_data	str	A CriteriaDTO to be applied to data, retain objects that are targets in returned data	[optional]
order_by	list[str]	List of fields to sort as an array of fieldName=asc	desc
page	int	Page number	[optional] [default to 0]
page_size	int	Page size	[optional] [default to 20]

Return type

list[ScientificObjectNodeDTO]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

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

search_scientific_objects_with_geometry_list_by_uris

list[ScientificObjectNodeDTO] search_scientific_objects_with_geometry_list_by_uris(experiment, authorization, start_date=start_date, end_date=end_date, accept_language=accept_language)

Get scientific objet list with geometry of a given experiment URI

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.ScientificObjectsApi(pythonClient)
experiment = 'http://example.com/' # str | Context URI
start_date = '2020-08-21' # str | Search by minimal date (optional)
end_date = '2020-08-22' # str | Search by maximal date (optional)


try:
    # Get scientific objet list with geometry of a given experiment URI
    api_response = api_instance.search_scientific_objects_with_geometry_list_by_uris(experiment, start_date=start_date, end_date=end_date, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling ScientificObjectsApi->search_scientific_objects_with_geometry_list_by_uris: %s\n" % e)

Parameters

Name	Type	Description	Notes
experiment	str	Context URI
start_date	str	Search by minimal date	[optional]
end_date	str	Search by maximal date	[optional]

Return type

list[ScientificObjectNodeDTO]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

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

update_scientific_object

str update_scientific_object(body, authorization, accept_language=accept_language)

Update a scientific object for the given experiment

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.ScientificObjectsApi(pythonClient)
body = opensilexClientToolsPython.ScientificObjectUpdateDTO() # ScientificObjectUpdateDTO | Scientific object description


try:
    # Update a scientific object for the given experiment
    api_response = api_instance.update_scientific_object(body, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling ScientificObjectsApi->update_scientific_object: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	ScientificObjectUpdateDTO	Scientific object description

Return type

str

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

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

validate_csv3

CSVValidationDTO validate_csv3(description, file, authorization, accept_language=accept_language)

Validate a CSV file for the given experiment URI and scientific object type.

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.ScientificObjectsApi(pythonClient)
description = 'description_example' # str | File description with metadata
file = '/path/to/file.txt' # file | Data file


try:
    # Validate a CSV file for the given experiment URI and scientific object type.
    api_response = api_instance.validate_csv3(description, file, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling ScientificObjectsApi->validate_csv3: %s\n" % e)

Parameters

Name	Type	Description	Notes
description	str	File description with metadata
file	file	Data file

Return type

CSVValidationDTO

Authorization

No authorization required

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

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

FilesExpand file tree

ScientificObjectsApi.md

Latest commit

History

ScientificObjectsApi.md

File metadata and controls

opensilexClientToolsPython.ScientificObjectsApi

count_scientific_objects

Example

Parameters

Return type

Authorization

HTTP request headers

create_scientific_object

Example

Parameters

Return type

Authorization

HTTP request headers

delete_scientific_object

Example

Parameters

Return type

Authorization

HTTP request headers

export_csv

Example

Parameters

Return type

Authorization

HTTP request headers

export_geospatial2

Example

Parameters

Return type

Authorization

HTTP request headers

get_scientific_object_data_files_provenances

Example

Parameters

Return type

Authorization

HTTP request headers

get_scientific_object_data_provenances

Example

Parameters

Return type

Authorization

HTTP request headers

get_scientific_object_detail

Example

Parameters

Return type

Authorization

HTTP request headers

get_scientific_object_detail_by_experiments

Example

Parameters

Return type

Authorization

HTTP request headers

get_scientific_object_variables

Example

Parameters

Return type

Authorization

HTTP request headers

get_scientific_objects_children

Example

Parameters

Return type

Authorization

HTTP request headers

get_scientific_objects_list_by_uris

Example

Parameters

Return type

Authorization

HTTP request headers

get_used_types