Skip to content

Latest commit

 

History

History
2127 lines (1497 loc) · 85 KB

DataApi.md

File metadata and controls

2127 lines (1497 loc) · 85 KB

opensilexClientToolsPython.DataApi

All URIs are relative to https://localhost

Method HTTP request Description
add_list_data POST /core/data Add data
count_data POST /core/data/count Count data
count_datafiles GET /core/datafiles/count Count datafiles
create_provenance POST /core/provenances Add a provenance
delete_data DELETE /core/data/{uri} Delete data
delete_data_on_search DELETE /core/data Delete data on criteria
delete_provenance DELETE /core/provenances/{uri} Delete a provenance that doesn't describe data
export_data GET /core/data/export Export data
export_data1 POST /core/data/export Export data
get_data GET /core/data/{uri} Get data
get_data_file GET /core/datafiles/{uri} Get a data file
get_data_file_description GET /core/datafiles/{uri}/description Get a data file description
get_data_file_descriptions_by_search GET /core/datafiles Search data files
get_data_file_descriptions_by_targets POST /core/datafiles/by_targets Search data files for a large list of targets
get_data_list_by_targets POST /core/data/by_targets Search data for a large list of targets
get_data_series_by_facility GET /core/data/data_serie/facility Get all data series associated with a facility
get_datafiles_provenances GET /core/datafiles/provenances Search provenances linked to datafiles
get_datafiles_provenances_by_targets POST /core/datafiles/provenances/by_targets Search provenances linked to datafiles for a large list of targets
get_mathematical_operators GET /core/data/mathematicalOperators Get mathematical operators
get_pictures_thumbnails GET /core/datafiles/{uri}/thumbnail Get a picture thumbnail
get_provenance GET /core/provenances/{uri} Get a provenance
get_provenances_by_uris GET /core/provenances/by_uris Get a list of provenances by their URIs
get_used_provenances GET /core/data/provenances Search provenances linked to data
get_used_provenances_by_targets POST /core/data/provenances/by_targets Search provenances linked to data for a large list of targets
get_used_variables GET /core/data/variables Get variables linked to data
import_csv_data POST /core/data/import Import a CSV file for the given provenanceURI
post_data_file POST /core/datafiles Add a data file
post_data_file_paths POST /core/datafiles/description Describe datafiles and give their relative paths in the configured storage system. In the case of already stored datafiles.
search_data_list GET /core/data Search data
search_data_list_by_targets POST /core/data/search Search data for a large list of targets
search_provenance GET /core/provenances Get provenances
update PUT /core/data Update data
update_confidence PUT /core/data/{uri}/confidence Update confidence index
update_provenance PUT /core/provenances Update a provenance
validate_csv POST /core/data/import_validation Import a CSV file for the given provenanceURI.

add_list_data

str add_list_data(authorization, body=body, accept_language=accept_language)

Add data

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.DataApi(pythonClient)
body = [opensilexClientToolsPython.DataCreationDTO()] # list[DataCreationDTO] | Data description (optional)


try:
    # Add data
    api_response = api_instance.add_list_data(body=body, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling DataApi->add_list_data: %s\n" % e)

Parameters

Name Type Description Notes
body list[DataCreationDTO] Data description [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]

count_data

int count_data(authorization, start_date=start_date, end_date=end_date, timezone=timezone, experiments=experiments, variables=variables, devices=devices, min_confidence=min_confidence, max_confidence=max_confidence, provenances=provenances, metadata=metadata, operators=operators, group_of_germplasm=group_of_germplasm, germplasm_uris=germplasm_uris, count_limit=count_limit, targets=targets, accept_language=accept_language)

Count data

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.DataApi(pythonClient)
start_date = '2020-08-21T00:00:00+01:00' # str | Search by minimal date (optional)
end_date = '2020-09-21T00:00:00+01:00' # str | Search by maximal date (optional)
timezone = 'Europe/Paris' # str | Precise the timezone corresponding to the given dates (optional)
experiments = ['http://opensilex/experiment/id/ZA17'] # list[str] | Search by experiment uris (optional)
variables = ['http://opensilex.dev/variable#variable.2020-08-21_11-21-23entity6_method6_quality6_unit6'] # list[str] | Search by variables uris (optional)
devices = ['http://opensilex.dev/set/device/sensingdevice-sensor_01'] # list[str] | Search by devices uris (optional)
min_confidence = 0.5 # float | Search by minimal confidence index (optional)
max_confidence = 1.0 # float | Search by maximal confidence index (optional)
provenances = ['http://opensilex.dev/provenance/1598001689415'] # list[str] | Search by provenances (optional)
metadata = '{ \"LabelView\" : \"side90\", \"paramA\" : \"90\"}' # str | Search by metadata (optional)
operators = ['dev:id/user/isa.droits'] # list[str] | Search by operators (optional)
group_of_germplasm = 'group_of_germplasm_example' # str | Group filter (optional)
germplasm_uris = ['germplasm_uris_example'] # list[str] | Germplasm uris, can be an empty array but can't be null (optional)
count_limit = 1000 # int | Count limit. Specify the maximum number of data to count. Set to 0 for no limit (optional) (default to 1000)
targets = [opensilexClientToolsPython.list[str]()] # list[str] | Targets uris, can be an empty array but can't be null (optional)


try:
    # Count data
    api_response = api_instance.count_data(start_date=start_date, end_date=end_date, timezone=timezone, experiments=experiments, variables=variables, devices=devices, min_confidence=min_confidence, max_confidence=max_confidence, provenances=provenances, metadata=metadata, operators=operators, group_of_germplasm=group_of_germplasm, germplasm_uris=germplasm_uris, count_limit=count_limit, targets=targets, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling DataApi->count_data: %s\n" % e)

Parameters

Name Type Description Notes
start_date str Search by minimal date [optional]
end_date str Search by maximal date [optional]
timezone str Precise the timezone corresponding to the given dates [optional]
experiments list[str] Search by experiment uris [optional]
variables list[str] Search by variables uris [optional]
devices list[str] Search by devices uris [optional]
min_confidence float Search by minimal confidence index [optional]
max_confidence float Search by maximal confidence index [optional]
provenances list[str] Search by provenances [optional]
metadata str Search by metadata [optional]
operators list[str] Search by operators [optional]
group_of_germplasm str Group filter [optional]
germplasm_uris list[str] Germplasm uris, can be an empty array but can't be null [optional]
count_limit int Count limit. Specify the maximum number of data to count. Set to 0 for no limit [optional] [default to 1000]
targets list[str] Targets uris, can be an empty array but can't be null [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]

count_datafiles

int count_datafiles(authorization, target=target, device=device, accept_language=accept_language)

Count datafiles

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.DataApi(pythonClient)
target = ['http://www.opensilex.org/demo/2018/o18000076'] # list[str] | Target URI (optional)
device = ['http://www.opensilex.org/demo/2018/o18000076'] # list[str] | Device URI (optional)


try:
    # Count datafiles
    api_response = api_instance.count_datafiles(target=target, device=device, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling DataApi->count_datafiles: %s\n" % e)

Parameters

Name Type Description Notes
target list[str] Target URI [optional]
device list[str] Device 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_provenance

str create_provenance(authorization, body=body, accept_language=accept_language)

Add a provenance

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.DataApi(pythonClient)
body = opensilexClientToolsPython.ProvenanceCreationDTO() # ProvenanceCreationDTO | Provenance description (optional)


try:
    # Add a provenance
    api_response = api_instance.create_provenance(body=body, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling DataApi->create_provenance: %s\n" % e)

Parameters

Name Type Description Notes
body ProvenanceCreationDTO Provenance description [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]

delete_data

str delete_data(uri, authorization, accept_language=accept_language)

Delete data

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.DataApi(pythonClient)
uri = 'http://opensilex.dev/id/data/1598857852858' # str | Data URI


try:
    # Delete data
    api_response = api_instance.delete_data(uri, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling DataApi->delete_data: %s\n" % e)

Parameters

Name Type Description Notes
uri str Data URI

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_data_on_search

str delete_data_on_search(authorization, experiment=experiment, target=target, variable=variable, provenance=provenance, accept_language=accept_language)

Delete data on criteria

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.DataApi(pythonClient)
experiment = 'http://opensilex/experiment/id/ZA17' # str | Search by experiment uri (optional)
target = 'http://opensilex.dev/opensilex/2020/o20000345' # str | Search by target uri (optional)
variable = 'http://opensilex.dev/variable#variable.2020-08-21_11-21-23entity6_method6_quality6_unit6' # str | Search by variable uri (optional)
provenance = 'http://opensilex.dev/provenance/1598001689415' # str | Search by provenance uri (optional)


try:
    # Delete data on criteria
    api_response = api_instance.delete_data_on_search(experiment=experiment, target=target, variable=variable, provenance=provenance, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling DataApi->delete_data_on_search: %s\n" % e)

Parameters

Name Type Description Notes
experiment str Search by experiment uri [optional]
target str Search by target uri [optional]
variable str Search by variable uri [optional]
provenance str Search by provenance 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]

delete_provenance

str delete_provenance(uri, authorization, accept_language=accept_language)

Delete a provenance that doesn't describe data

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.DataApi(pythonClient)
uri = 'http://opensilex.dev/id/provenance/provenancelabel' # str | Provenance URI


try:
    # Delete a provenance that doesn't describe data
    api_response = api_instance.delete_provenance(uri, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling DataApi->delete_provenance: %s\n" % e)

Parameters

Name Type Description Notes
uri str Provenance URI

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_data

export_data(authorization, start_date=start_date, end_date=end_date, timezone=timezone, experiments=experiments, targets=targets, variables=variables, devices=devices, min_confidence=min_confidence, max_confidence=max_confidence, provenances=provenances, metadata=metadata, operators=operators, mode=mode, with_raw_data=with_raw_data, order_by=order_by, page=page, page_size=page_size, accept_language=accept_language)

Export data

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.DataApi(pythonClient)
start_date = '2020-08-21T00:00:00+01:00' # str | Search by minimal date (optional)
end_date = '2020-09-21T00:00:00+01:00' # str | Search by maximal date (optional)
timezone = 'Europe/Paris' # str | Precise the timezone corresponding to the given dates (optional)
experiments = ['http://opensilex/experiment/id/ZA17'] # list[str] | Search by experiment uris (optional)
targets = ['http://opensilex.dev/opensilex/2020/o20000345'] # list[str] | Search by targets (optional)
variables = ['http://opensilex.dev/variable#variable.2020-08-21_11-21-23entity6_method6_quality6_unit6'] # list[str] | Search by variables (optional)
devices = ['http://opensilex.dev/set/device/sensingdevice-sensor_01'] # list[str] | Search by devices uris (optional)
min_confidence = 0.5 # float | Search by minimal confidence index (optional)
max_confidence = 0.5 # float | Search by maximal confidence index (optional)
provenances = ['http://opensilex.dev/provenance/1598001689415'] # list[str] | Search by provenances (optional)
metadata = '{ \"LabelView\" : \"side90\", \"paramA\" : \"90\"}' # str | Search by metadata (optional)
operators = ['dev:id/user/isa.droits'] # list[str] | Search by operators (optional)
mode = 'wide' # str | Format wide or long (optional) (default to wide)
with_raw_data = false # bool | Export also raw_data (optional) (default to false)
order_by = ['date=desc'] # 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:
    # Export data
    api_instance.export_data(start_date=start_date, end_date=end_date, timezone=timezone, experiments=experiments, targets=targets, variables=variables, devices=devices, min_confidence=min_confidence, max_confidence=max_confidence, provenances=provenances, metadata=metadata, operators=operators, mode=mode, with_raw_data=with_raw_data, order_by=order_by, page=page, page_size=page_size, )
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling DataApi->export_data: %s\n" % e)

Parameters

Name Type Description Notes
start_date str Search by minimal date [optional]
end_date str Search by maximal date [optional]
timezone str Precise the timezone corresponding to the given dates [optional]
experiments list[str] Search by experiment uris [optional]
targets list[str] Search by targets [optional]
variables list[str] Search by variables [optional]
devices list[str] Search by devices uris [optional]
min_confidence float Search by minimal confidence index [optional]
max_confidence float Search by maximal confidence index [optional]
provenances list[str] Search by provenances [optional]
metadata str Search by metadata [optional]
operators list[str] Search by operators [optional]
mode str Format wide or long [optional] [default to wide]
with_raw_data bool Export also raw_data [optional] [default to false]
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

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: text/plain

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

export_data1

export_data1(authorization, body=body, accept_language=accept_language)

Export data

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


try:
    # Export data
    api_instance.export_data1(body=body, )
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling DataApi->export_data1: %s\n" % e)

Parameters

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

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: text/plain

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

get_data

DataGetDetailsDTO get_data(uri, authorization, accept_language=accept_language)

Get data

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.DataApi(pythonClient)
uri = 'uri_example' # str | Data URI


try:
    # Get data
    api_response = api_instance.get_data(uri, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling DataApi->get_data: %s\n" % e)

Parameters

Name Type Description Notes
uri str Data URI

Return type

DataGetDetailsDTO

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_data_file

get_data_file(uri, authorization, accept_language=accept_language)

Get a 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.DataApi(pythonClient)
uri = 'uri_example' # str | Search by fileUri


try:
    # Get a data file
    api_instance.get_data_file(uri, )
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling DataApi->get_data_file: %s\n" % e)

Parameters

Name Type Description Notes
uri str Search by fileUri

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_data_file_description

DataFileGetDTO get_data_file_description(uri, authorization, accept_language=accept_language)

Get a data file description

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.DataApi(pythonClient)
uri = 'uri_example' # str | Search by fileUri


try:
    # Get a data file description
    api_response = api_instance.get_data_file_description(uri, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling DataApi->get_data_file_description: %s\n" % e)

Parameters

Name Type Description Notes
uri str Search by fileUri

Return type

DataFileGetDTO

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_data_file_descriptions_by_search

list[DataFileGetDTO] get_data_file_descriptions_by_search(authorization, rdf_type=rdf_type, start_date=start_date, end_date=end_date, timezone=timezone, experiments=experiments, targets=targets, devices=devices, provenances=provenances, metadata=metadata, order_by=order_by, page=page, page_size=page_size, accept_language=accept_language)

Search data files

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.DataApi(pythonClient)
rdf_type = 'rdf_type_example' # str | Search by rdf type uri (optional)
start_date = '2020-08-21T00:00:00+01:00' # str | Search by minimal date (optional)
end_date = '2020-09-21T00:00:00+01:00' # str | Search by maximal date (optional)
timezone = 'Europe/Paris' # str | Precise the timezone corresponding to the given dates (optional)
experiments = ['http://opensilex/experiment/id/ZA17'] # list[str] | Search by experiments (optional)
targets = ['http://opensilex.dev/opensilex/2020/o20000345'] # list[str] | Search by targets uris list (optional)
devices = ['http://opensilex.dev/set/device/sensingdevice-sensor_01'] # list[str] | Search by devices uris (optional)
provenances = ['http://opensilex.dev/provenance/1598001689415'] # list[str] | Search by provenance uris list (optional)
metadata = '{ \"LabelView\" : \"side90\", \"paramA\" : \"90\"}' # str | Search by metadata (optional)
order_by = ['date=desc'] # 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 data files
    api_response = api_instance.get_data_file_descriptions_by_search(rdf_type=rdf_type, start_date=start_date, end_date=end_date, timezone=timezone, experiments=experiments, targets=targets, devices=devices, provenances=provenances, metadata=metadata, order_by=order_by, page=page, page_size=page_size, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling DataApi->get_data_file_descriptions_by_search: %s\n" % e)

Parameters

Name Type Description Notes
rdf_type str Search by rdf type uri [optional]
start_date str Search by minimal date [optional]
end_date str Search by maximal date [optional]
timezone str Precise the timezone corresponding to the given dates [optional]
experiments list[str] Search by experiments [optional]
targets list[str] Search by targets uris list [optional]
devices list[str] Search by devices uris [optional]
provenances list[str] Search by provenance uris list [optional]
metadata str Search by metadata [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[DataFileGetDTO]

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_data_file_descriptions_by_targets

list[DataFileGetDTO] get_data_file_descriptions_by_targets(authorization, rdf_type=rdf_type, start_date=start_date, end_date=end_date, timezone=timezone, experiments=experiments, devices=devices, provenances=provenances, metadata=metadata, order_by=order_by, page=page, page_size=page_size, targets=targets, accept_language=accept_language)

Search data files for a large list of targets

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.DataApi(pythonClient)
rdf_type = 'rdf_type_example' # str | Search by rdf type uri (optional)
start_date = '2020-08-21T00:00:00+01:00' # str | Search by minimal date (optional)
end_date = '2020-09-21T00:00:00+01:00' # str | Search by maximal date (optional)
timezone = 'Europe/Paris' # str | Precise the timezone corresponding to the given dates (optional)
experiments = ['http://opensilex/experiment/id/ZA17'] # list[str] | Search by experiments (optional)
devices = ['http://opensilex.dev/set/device/sensingdevice-sensor_01'] # list[str] | Search by devices uris (optional)
provenances = ['http://opensilex.dev/provenance/1598001689415'] # list[str] | Search by provenance uris list (optional)
metadata = '{ \"LabelView\" : \"side90\", \"paramA\" : \"90\"}' # str | Search by metadata (optional)
order_by = ['date=desc'] # 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)
targets = [opensilexClientToolsPython.list[str]()] # list[str] | Targets uris, can be an empty array but can't be null (optional)


try:
    # Search data files for a large list of targets 
    api_response = api_instance.get_data_file_descriptions_by_targets(rdf_type=rdf_type, start_date=start_date, end_date=end_date, timezone=timezone, experiments=experiments, devices=devices, provenances=provenances, metadata=metadata, order_by=order_by, page=page, page_size=page_size, targets=targets, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling DataApi->get_data_file_descriptions_by_targets: %s\n" % e)

Parameters

Name Type Description Notes
rdf_type str Search by rdf type uri [optional]
start_date str Search by minimal date [optional]
end_date str Search by maximal date [optional]
timezone str Precise the timezone corresponding to the given dates [optional]
experiments list[str] Search by experiments [optional]
devices list[str] Search by devices uris [optional]
provenances list[str] Search by provenance uris list [optional]
metadata str Search by metadata [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]
targets list[str] Targets uris, can be an empty array but can't be null [optional]

Return type

list[DataFileGetDTO]

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_data_list_by_targets

list[DataGetSearchDTO] get_data_list_by_targets(authorization, start_date=start_date, end_date=end_date, timezone=timezone, experiments=experiments, targets=targets, variables=variables, devices=devices, min_confidence=min_confidence, max_confidence=max_confidence, provenances=provenances, metadata=metadata, group_of_germplasm=group_of_germplasm, operators=operators, germplasm_uris=germplasm_uris, order_by=order_by, page=page, page_size=page_size, accept_language=accept_language)

Search data for a large list of targets

Deprecated. Use searchDataListByTargets (/search) service which is more optimized

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.DataApi(pythonClient)
start_date = '2020-08-21T00:00:00+01:00' # str | Search by minimal date (optional)
end_date = '2020-09-21T00:00:00+01:00' # str | Search by maximal date (optional)
timezone = 'Europe/Paris' # str | Precise the timezone corresponding to the given dates (optional)
experiments = ['http://opensilex/experiment/id/ZA17'] # list[str] | Search by experiment uris (optional)
targets = [opensilexClientToolsPython.list[str]()] # list[str] | Targets uris, can be an empty array but can't be null (optional)
variables = ['http://opensilex.dev/variable#variable.2020-08-21_11-21-23entity6_method6_quality6_unit6'] # list[str] | Search by variables uris (optional)
devices = ['http://opensilex.dev/set/device/sensingdevice-sensor_01'] # list[str] | Search by devices uris (optional)
min_confidence = 0.5 # float | Search by minimal confidence index (optional)
max_confidence = 1.0 # float | Search by maximal confidence index (optional)
provenances = ['http://opensilex.dev/provenance/1598001689415'] # list[str] | Search by provenances (optional)
metadata = '{ \"LabelView\" : \"side90\", \"paramA\" : \"90\"}' # str | Search by metadata (optional)
group_of_germplasm = 'group_of_germplasm_example' # str | Group filter (optional)
operators = ['dev:id/user/isa.droits'] # list[str] | Search by operators (optional)
germplasm_uris = ['germplasm_uris_example'] # list[str] | Targets uris, can be an empty array but can't be null (optional)
order_by = ['date=desc'] # 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 data for a large list of targets
    api_response = api_instance.get_data_list_by_targets(start_date=start_date, end_date=end_date, timezone=timezone, experiments=experiments, targets=targets, variables=variables, devices=devices, min_confidence=min_confidence, max_confidence=max_confidence, provenances=provenances, metadata=metadata, group_of_germplasm=group_of_germplasm, operators=operators, germplasm_uris=germplasm_uris, order_by=order_by, page=page, page_size=page_size, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling DataApi->get_data_list_by_targets: %s\n" % e)

Parameters

Name Type Description Notes
start_date str Search by minimal date [optional]
end_date str Search by maximal date [optional]
timezone str Precise the timezone corresponding to the given dates [optional]
experiments list[str] Search by experiment uris [optional]
targets list[str] Targets uris, can be an empty array but can't be null [optional]
variables list[str] Search by variables uris [optional]
devices list[str] Search by devices uris [optional]
min_confidence float Search by minimal confidence index [optional]
max_confidence float Search by maximal confidence index [optional]
provenances list[str] Search by provenances [optional]
metadata str Search by metadata [optional]
group_of_germplasm str Group filter [optional]
operators list[str] Search by operators [optional]
germplasm_uris list[str] Targets uris, can be an empty array but can't be null [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[DataGetSearchDTO]

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_data_series_by_facility

DataVariableSeriesGetDTO get_data_series_by_facility(variable, target, authorization, start_date=start_date, end_date=end_date, calculated_only=calculated_only, accept_language=accept_language)

Get all data series associated with a facility

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.DataApi(pythonClient)
variable = 'http://example.com/' # str | variable URI
target = 'http://example.com/' # str | target URI
start_date = '2020-08-21T00:00:00+01:00' # str | Search by minimal date (optional)
end_date = '2020-09-21T00:00:00+01:00' # str | Search by maximal date (optional)
calculated_only = false # bool | Retreive calculated series only (optional)


try:
    # Get all data series associated with a facility
    api_response = api_instance.get_data_series_by_facility(variable, target, start_date=start_date, end_date=end_date, calculated_only=calculated_only, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling DataApi->get_data_series_by_facility: %s\n" % e)

Parameters

Name Type Description Notes
variable str variable URI
target str target URI
start_date str Search by minimal date [optional]
end_date str Search by maximal date [optional]
calculated_only bool Retreive calculated series only [optional]

Return type

DataVariableSeriesGetDTO

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_datafiles_provenances

list[ProvenanceGetDTO] get_datafiles_provenances(authorization, experiments=experiments, targets=targets, devices=devices, accept_language=accept_language)

Search provenances linked to datafiles

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.DataApi(pythonClient)
experiments = ['http://opensilex/experiment/id/ZA17'] # list[str] | Search by experiment uris (optional)
targets = ['http://opensilex.dev/opensilex/2020/o20000345'] # list[str] | Search by targets uris (optional)
devices = ['http://opensilex.dev/set/device/sensingdevice-sensor_01'] # list[str] | Search by devices uris (optional)


try:
    # Search provenances linked to datafiles
    api_response = api_instance.get_datafiles_provenances(experiments=experiments, targets=targets, devices=devices, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling DataApi->get_datafiles_provenances: %s\n" % e)

Parameters

Name Type Description Notes
experiments list[str] Search by experiment uris [optional]
targets list[str] Search by targets uris [optional]
devices list[str] Search by devices uris [optional]

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_datafiles_provenances_by_targets

list[ProvenanceGetDTO] get_datafiles_provenances_by_targets(authorization, experiments=experiments, devices=devices, body=body, accept_language=accept_language)

Search provenances linked to datafiles for a large list of targets

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.DataApi(pythonClient)
experiments = ['http://opensilex/experiment/id/ZA17'] # list[str] | Search by experiment uris (optional)
devices = ['http://opensilex.dev/set/device/sensingdevice-sensor_01'] # list[str] | Search by devices uris (optional)
body = [opensilexClientToolsPython.list[str]()] # list[str] | Search by targets uris (optional)


try:
    # Search provenances linked to datafiles for a large list of targets
    api_response = api_instance.get_datafiles_provenances_by_targets(experiments=experiments, devices=devices, body=body, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling DataApi->get_datafiles_provenances_by_targets: %s\n" % e)

Parameters

Name Type Description Notes
experiments list[str] Search by experiment uris [optional]
devices list[str] Search by devices uris [optional]
body list[str] Search by targets uris [optional]

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_mathematical_operators

list[str] get_mathematical_operators(authorization, accept_language=accept_language)

Get mathematical operators

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.DataApi(pythonClient)


try:
    # Get mathematical operators
    api_response = api_instance.get_mathematical_operators()
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling DataApi->get_mathematical_operators: %s\n" % e)

Parameters

Name Type Description Notes

Return type

list[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]

get_pictures_thumbnails

get_pictures_thumbnails(uri, authorization, scaled_width=scaled_width, scaled_height=scaled_height, accept_language=accept_language)

Get a picture thumbnail

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.DataApi(pythonClient)
uri = 'uri_example' # str | Search by fileUri
scaled_width = 640 # int | Thumbnail width (optional) (default to 640)
scaled_height = 360 # int | Thumbnail height (optional) (default to 360)


try:
    # Get a picture thumbnail
    api_instance.get_pictures_thumbnails(uri, scaled_width=scaled_width, scaled_height=scaled_height, )
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling DataApi->get_pictures_thumbnails: %s\n" % e)

Parameters

Name Type Description Notes
uri str Search by fileUri
scaled_width int Thumbnail width [optional] [default to 640]
scaled_height int Thumbnail height [optional] [default to 360]

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_provenance

ProvenanceGetDTO get_provenance(uri, authorization, accept_language=accept_language)

Get a provenance

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.DataApi(pythonClient)
uri = 'uri_example' # str | Provenance URI


try:
    # Get a provenance
    api_response = api_instance.get_provenance(uri, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling DataApi->get_provenance: %s\n" % e)

Parameters

Name Type Description Notes
uri str Provenance URI

Return type

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_provenances_by_uris

list[ProvenanceGetDTO] get_provenances_by_uris(uris, authorization, accept_language=accept_language)

Get a list of provenances by their URIs

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.DataApi(pythonClient)
uris = ['uris_example'] # list[str] | Provenances URIs


try:
    # Get a list of provenances by their URIs
    api_response = api_instance.get_provenances_by_uris(uris, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling DataApi->get_provenances_by_uris: %s\n" % e)

Parameters

Name Type Description Notes
uris list[str] Provenances URIs

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_used_provenances

list[ProvenanceGetDTO] get_used_provenances(authorization, experiments=experiments, targets=targets, variables=variables, devices=devices, accept_language=accept_language)

Search provenances linked to data

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.DataApi(pythonClient)
experiments = ['http://opensilex/experiment/id/ZA17'] # list[str] | Search by experiment uris (optional)
targets = ['http://opensilex.dev/opensilex/2020/o20000345'] # list[str] | Search by targets uris (optional)
variables = ['http://opensilex.dev/variable#variable.2020-08-21_11-21-23entity6_method6_quality6_unit6'] # list[str] | Search by variables uris (optional)
devices = ['http://opensilex.dev/set/device/sensingdevice-sensor_01'] # list[str] | Search by devices uris (optional)


try:
    # Search provenances linked to data
    api_response = api_instance.get_used_provenances(experiments=experiments, targets=targets, variables=variables, devices=devices, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling DataApi->get_used_provenances: %s\n" % e)

Parameters

Name Type Description Notes
experiments list[str] Search by experiment uris [optional]
targets list[str] Search by targets uris [optional]
variables list[str] Search by variables uris [optional]
devices list[str] Search by devices uris [optional]

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_used_provenances_by_targets

list[ProvenanceGetDTO] get_used_provenances_by_targets(authorization, experiments=experiments, variables=variables, devices=devices, body=body, accept_language=accept_language)

Search provenances linked to data for a large list of targets

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.DataApi(pythonClient)
experiments = ['http://opensilex/experiment/id/ZA17'] # list[str] | Search by experiment uris (optional)
variables = ['http://opensilex.dev/variable#variable.2020-08-21_11-21-23entity6_method6_quality6_unit6'] # list[str] | Search by variables uris (optional)
devices = ['http://opensilex.dev/set/device/sensingdevice-sensor_01'] # list[str] | Search by devices uris (optional)
body = [opensilexClientToolsPython.list[str]()] # list[str] | Targets uris (optional)


try:
    # Search provenances linked to data for a large list of targets
    api_response = api_instance.get_used_provenances_by_targets(experiments=experiments, variables=variables, devices=devices, body=body, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling DataApi->get_used_provenances_by_targets: %s\n" % e)

Parameters

Name Type Description Notes
experiments list[str] Search by experiment uris [optional]
variables list[str] Search by variables uris [optional]
devices list[str] Search by devices uris [optional]
body list[str] Targets uris [optional]

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_used_variables

list[VariableGetDTO] get_used_variables(authorization, experiments=experiments, targets=targets, provenances=provenances, devices=devices, accept_language=accept_language)

Get variables linked to data

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.DataApi(pythonClient)
experiments = ['http://opensilex/experiment/id/ZA17'] # list[str] | Search by experiment uris (optional)
targets = ['http://opensilex.dev/opensilex/2020/o20000345'] # list[str] | Search by targets uris (optional)
provenances = ['http://opensilex.dev/variable#variable.2020-08-21_11-21-23entity6_method6_quality6_unit6'] # list[str] | Search by provenance uris (optional)
devices = ['devices_example'] # list[str] | Search by device uris (optional)


try:
    # Get variables linked to data
    api_response = api_instance.get_used_variables(experiments=experiments, targets=targets, provenances=provenances, devices=devices, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling DataApi->get_used_variables: %s\n" % e)

Parameters

Name Type Description Notes
experiments list[str] Search by experiment uris [optional]
targets list[str] Search by targets uris [optional]
provenances list[str] Search by provenance uris [optional]
devices list[str] Search by device uris [optional]

Return type

list[VariableGetDTO]

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_csv_data

DataCSVValidationDTO import_csv_data(provenance, file, authorization, experiment=experiment, accept_language=accept_language)

Import a CSV file for the given provenanceURI

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.DataApi(pythonClient)
provenance = 'http://opensilex.dev/id/provenance/provenancelabel' # str | Provenance URI
file = '/path/to/file.txt' # file | File
experiment = 'http://opensilex/experiment/id/ZA17' # str | Experiment URI (optional)


try:
    # Import a CSV file for the given provenanceURI
    api_response = api_instance.import_csv_data(provenance, file, experiment=experiment, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling DataApi->import_csv_data: %s\n" % e)

Parameters

Name Type Description Notes
provenance str Provenance URI
file file File
experiment str Experiment URI [optional]

Return type

DataCSVValidationDTO

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]

post_data_file

str post_data_file(description, file, authorization, accept_language=accept_language)

Add a data file

{"rdf_type":"http://www.opensilex.org/vocabulary/oeso#Image\", "date":"2020-08-21T00:00:00+01:00", "target":"http://plot01\", "provenance": { "uri":"http://opensilex.dev/provenance/1598001689415\" }, "metadata":{ "LabelView" : "side90", "paramA" : "90"}}

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


try:
    # Add a data file
    api_response = api_instance.post_data_file(description, file, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling DataApi->post_data_file: %s\n" % e)

Parameters

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

Return type

str

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]

post_data_file_paths

str post_data_file_paths(body, authorization, accept_language=accept_language)

Describe datafiles and give their relative paths in the configured storage system. In the case of already stored datafiles.

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.DataApi(pythonClient)
body = [opensilexClientToolsPython.DataFilePathCreationDTO()] # list[DataFilePathCreationDTO] | Metadata of the file


try:
    # Describe datafiles and give their relative paths in the configured storage system. In the case of already stored datafiles.
    api_response = api_instance.post_data_file_paths(body, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling DataApi->post_data_file_paths: %s\n" % e)

Parameters

Name Type Description Notes
body list[DataFilePathCreationDTO] Metadata of the file

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]

search_data_list

list[DataGetSearchDTO] search_data_list(authorization, start_date=start_date, end_date=end_date, timezone=timezone, experiments=experiments, targets=targets, variables=variables, devices=devices, min_confidence=min_confidence, max_confidence=max_confidence, provenances=provenances, metadata=metadata, operators=operators, order_by=order_by, page=page, page_size=page_size, accept_language=accept_language)

Search data

Deprecated. Use searchDataListByTargets (/search) service which is more optimized

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.DataApi(pythonClient)
start_date = '2020-08-21T00:00:00+01:00' # str | Search by minimal date (optional)
end_date = '2020-09-21T00:00:00+01:00' # str | Search by maximal date (optional)
timezone = 'Europe/Paris' # str | Precise the timezone corresponding to the given dates (optional)
experiments = ['http://opensilex/experiment/id/ZA17'] # list[str] | Search by experiment uris (optional)
targets = ['http://opensilex.dev/opensilex/2020/o20000345'] # list[str] | Search by targets uris (optional)
variables = ['http://opensilex.dev/variable#variable.2020-08-21_11-21-23entity6_method6_quality6_unit6'] # list[str] | Search by variables uris (optional)
devices = ['http://opensilex.dev/set/device/sensingdevice-sensor_01'] # list[str] | Search by devices uris (optional)
min_confidence = 0.5 # float | Search by minimal confidence index (optional)
max_confidence = 1.0 # float | Search by maximal confidence index (optional)
provenances = ['http://opensilex.dev/provenance/1598001689415'] # list[str] | Search by provenances (optional)
metadata = '{ \"LabelView\" : \"side90\", \"paramA\" : \"90\"}' # str | Search by metadata (optional)
operators = ['dev:id/user/isa.droits'] # list[str] | Search by operators (optional)
order_by = ['date=desc'] # 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 data
    api_response = api_instance.search_data_list(start_date=start_date, end_date=end_date, timezone=timezone, experiments=experiments, targets=targets, variables=variables, devices=devices, min_confidence=min_confidence, max_confidence=max_confidence, provenances=provenances, metadata=metadata, operators=operators, order_by=order_by, page=page, page_size=page_size, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling DataApi->search_data_list: %s\n" % e)

Parameters

Name Type Description Notes
start_date str Search by minimal date [optional]
end_date str Search by maximal date [optional]
timezone str Precise the timezone corresponding to the given dates [optional]
experiments list[str] Search by experiment uris [optional]
targets list[str] Search by targets uris [optional]
variables list[str] Search by variables uris [optional]
devices list[str] Search by devices uris [optional]
min_confidence float Search by minimal confidence index [optional]
max_confidence float Search by maximal confidence index [optional]
provenances list[str] Search by provenances [optional]
metadata str Search by metadata [optional]
operators list[str] Search by operators [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[DataGetSearchDTO]

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_data_list_by_targets

list[DataGetSearchDTO] search_data_list_by_targets(authorization, start_date=start_date, end_date=end_date, timezone=timezone, experiments=experiments, targets=targets, variables=variables, devices=devices, min_confidence=min_confidence, max_confidence=max_confidence, provenances=provenances, metadata=metadata, group_of_germplasm=group_of_germplasm, operators=operators, germplasm_uris=germplasm_uris, order_by=order_by, page=page, page_size=page_size, accept_language=accept_language)

Search data for a large list of targets

Optimized search. The total count of element is not returned. Use countData (/count) service in order to get exact count of element

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.DataApi(pythonClient)
start_date = '2020-08-21T00:00:00+01:00' # str | Search by minimal date (optional)
end_date = '2020-09-21T00:00:00+01:00' # str | Search by maximal date (optional)
timezone = 'Europe/Paris' # str | Precise the timezone corresponding to the given dates (optional)
experiments = ['http://opensilex/experiment/id/ZA17'] # list[str] | Search by experiment uris (optional)
targets = [opensilexClientToolsPython.list[str]()] # list[str] | Targets uris, can be an empty array but can't be null (optional)
variables = ['http://opensilex.dev/variable#variable.2020-08-21_11-21-23entity6_method6_quality6_unit6'] # list[str] | Search by variables uris (optional)
devices = ['http://opensilex.dev/set/device/sensingdevice-sensor_01'] # list[str] | Search by devices uris (optional)
min_confidence = 0.5 # float | Search by minimal confidence index (optional)
max_confidence = 1.0 # float | Search by maximal confidence index (optional)
provenances = ['http://opensilex.dev/provenance/1598001689415'] # list[str] | Search by provenances (optional)
metadata = '{ \"LabelView\" : \"side90\", \"paramA\" : \"90\"}' # str | Search by metadata (optional)
group_of_germplasm = 'group_of_germplasm_example' # str | Group filter (optional)
operators = ['dev:id/user/isa.droits'] # list[str] | Search by operators (optional)
germplasm_uris = ['germplasm_uris_example'] # list[str] | Targets uris, can be an empty array but can't be null (optional)
order_by = ['date=desc'] # 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 data for a large list of targets
    api_response = api_instance.search_data_list_by_targets(start_date=start_date, end_date=end_date, timezone=timezone, experiments=experiments, targets=targets, variables=variables, devices=devices, min_confidence=min_confidence, max_confidence=max_confidence, provenances=provenances, metadata=metadata, group_of_germplasm=group_of_germplasm, operators=operators, germplasm_uris=germplasm_uris, order_by=order_by, page=page, page_size=page_size, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling DataApi->search_data_list_by_targets: %s\n" % e)

Parameters

Name Type Description Notes
start_date str Search by minimal date [optional]
end_date str Search by maximal date [optional]
timezone str Precise the timezone corresponding to the given dates [optional]
experiments list[str] Search by experiment uris [optional]
targets list[str] Targets uris, can be an empty array but can't be null [optional]
variables list[str] Search by variables uris [optional]
devices list[str] Search by devices uris [optional]
min_confidence float Search by minimal confidence index [optional]
max_confidence float Search by maximal confidence index [optional]
provenances list[str] Search by provenances [optional]
metadata str Search by metadata [optional]
group_of_germplasm str Group filter [optional]
operators list[str] Search by operators [optional]
germplasm_uris list[str] Targets uris, can be an empty array but can't be null [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[DataGetSearchDTO]

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_provenance

list[ProvenanceGetDTO] search_provenance(authorization, name=name, description=description, activity=activity, activity_type=activity_type, agent=agent, agent_type=agent_type, order_by=order_by, page=page, page_size=page_size, accept_language=accept_language)

Get provenances

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.DataApi(pythonClient)
name = 'name_example' # str | Regex pattern for filtering by name (optional)
description = 'description_example' # str | Search by description (optional)
activity = 'activity_example' # str | Search by activity URI (optional)
activity_type = 'activity_type_example' # str | Search by activity type (optional)
agent = ['agent_example'] # list[str] | Search by agent URIs (optional)
agent_type = 'agent_type_example' # str | Search by agent type (optional)
order_by = ['date=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 provenances
    api_response = api_instance.search_provenance(name=name, description=description, activity=activity, activity_type=activity_type, agent=agent, agent_type=agent_type, order_by=order_by, page=page, page_size=page_size, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling DataApi->search_provenance: %s\n" % e)

Parameters

Name Type Description Notes
name str Regex pattern for filtering by name [optional]
description str Search by description [optional]
activity str Search by activity URI [optional]
activity_type str Search by activity type [optional]
agent list[str] Search by agent URIs [optional]
agent_type str Search by agent type [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[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]

update

str update(authorization, body=body, accept_language=accept_language)

Update data

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.DataApi(pythonClient)
body = opensilexClientToolsPython.DataUpdateDTO() # DataUpdateDTO | Data description (optional)


try:
    # Update data
    api_response = api_instance.update(body=body, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling DataApi->update: %s\n" % e)

Parameters

Name Type Description Notes
body DataUpdateDTO Data description [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]

update_confidence

str update_confidence(uri, authorization, body=body, accept_language=accept_language)

Update confidence index

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.DataApi(pythonClient)
uri = 'uri_example' # str | Data URI
body = opensilexClientToolsPython.DataConfidenceDTO() # DataConfidenceDTO | Data description (optional)


try:
    # Update confidence index
    api_response = api_instance.update_confidence(uri, body=body, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling DataApi->update_confidence: %s\n" % e)

Parameters

Name Type Description Notes
uri str Data URI
body DataConfidenceDTO Data description [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]

update_provenance

str update_provenance(authorization, body=body, accept_language=accept_language)

Update a provenance

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.DataApi(pythonClient)
body = opensilexClientToolsPython.ProvenanceUpdateDTO() # ProvenanceUpdateDTO | Provenance description (optional)


try:
    # Update a provenance
    api_response = api_instance.update_provenance(body=body, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling DataApi->update_provenance: %s\n" % e)

Parameters

Name Type Description Notes
body ProvenanceUpdateDTO Provenance description [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]

validate_csv

DataCSVValidationDTO validate_csv(provenance, file, authorization, experiment=experiment, accept_language=accept_language)

Import a CSV file for the given provenanceURI.

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.DataApi(pythonClient)
provenance = 'http://opensilex.dev/id/provenance/provenancelabel' # str | Provenance URI
file = '/path/to/file.txt' # file | File
experiment = 'http://opensilex/experiment/id/ZA17' # str | Experiment URI (optional)


try:
    # Import a CSV file for the given provenanceURI.
    api_response = api_instance.validate_csv(provenance, file, experiment=experiment, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling DataApi->validate_csv: %s\n" % e)

Parameters

Name Type Description Notes
provenance str Provenance URI
file file File
experiment str Experiment URI [optional]

Return type

DataCSVValidationDTO

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]