Web Services

BED offers a suite of web services that users can interact with programmatically. Below, you'll find collections of API requests supported by our web services, organized for easy access and integration into your projects. Data must be obtained using any prgram supporting the HTTP-POST and HTTP-GET methods, e.g. CURL . Alternatively, click Download to get the collections in JSON format and start exploring the possibilities with the BED 's APIs.

APIs

All APIs can be used with the -o outputfilename.json option to store the results in a file.

Dataset-related API requests

Filter datasets based on taxonomy strings using a tax keyword

This API allows you to filter datasets based on taxonomy strings using a tax keyword. By specifying taxonomy strings with the tax keyword, you can narrow down the datasets to those that match your specific criteria, facilitating efficient exploration and analysis. The tax keyword allows you to specify taxonomy strings for different attributes, such as specimen type, specimen sub-type, material type, and material technology.

Parameters

-H "Content-Type: application/json": This header specifies the content type of the request payload as JSON.
-d '{ "tax": "FSA/CR" }': This option sends the taxonomy string with the tax keyword as a JSON object in the request body. Replace "FSA/CR" with your desired taxonomy string using the tax keyword.

Usage

To filter datasets based on taxonomy strings using the tax keyword, make a POST request to the provided URL with the appropriate headers and payload containing the taxonomy string with the tax keyword.

curl -X POST "https://experiments.builtenvdata.eu/api/v1/datasets/explore-results/" -H "Content-Type: application/json" -d "{
                        \"tax\": \"KEYWORD1/KEYWORD2\" }"

Filter datasets based on metadata

This API allows you to filter datasets based on metadata. By specifying metadata filters for various attributes, you can narrow down the datasets to those that match your specific criteria, facilitating efficient exploration and analysis. The attributes may include engineering discipline, license type, experiment type, and experiment scale.

Parameters

-H "Content-Type: application/json": This header specifies the content type of the request payload as JSON.
-d '{ "engineeringDiscipline": "Any", "license": "Any", "experimentType": "Any", "experimentScale": "Any" }': This option sends the metadata filters for various attributes as a JSON object in the request body. Replace "Any" with your desired metadata for each attribute. "Any" stands for a default value meaning that all available options will be returned

Usage

To filter datasets based on metadata, make a POST request to the provided URL with the appropriate headers and payload containing metadata filters for the desired attributes.

curl -X POST "https://experiments.builtenvdata.eu/api/v1/datasets/filter-results/" -H "Content-Type: application/json" -d "{
                        \"engineeringDiscipline\": \"Any\",
                        \"license\": \"Any\",
                        \"experimentType\": \"Any\",
                        \"experimentScale\": \"Any\" }"

4 most downloaded datasets

This API allows you to retrieve information about the four most downloaded datasets from the platform. These datasets are chosen based on their popularity among users, making them particularly relevant for various research and analytical purposes.

curl -X GET "https://experiments.builtenvdata.eu/api/v1/most-downloaded-datasets/"

4 latest uploaded datasets

This API allows you to retrieve information about the four most recently uploaded datasets to the platform. These datasets are selected based on their upload timestamps.

curl -X GET "https://experiments.builtenvdata.eu/api/v1/latest-datasets/"

All datasets

This API allows you to retrieve information about all datasets available on the platform. Each dataset is accompanied by detailed information, including its title, description, metadata, authors, facility, licence, taxonomy, DOI, publications and files associated with the dataset, and download statistics.

curl -X GET "https://experiments.builtenvdata.eu/api/v1/all-datasets"

Retrieve datasets based on search query

This API allows you to retrieve datasets based on a search query. By specifying a search query, you can narrow down the datasets to those that match your specific criteria, enabling efficient exploration and analysis. The search query may include text found in experiment title, keywords, description, facility name, Principal Investigator (PI)(s) first and last name.

Parameters

-H "Content-Type: application/json": This header specifies the content type of the request payload as JSON.
-d '{ "query": "query-text" }': This option sends the search query as a JSON object in the request body. Replace "query-text" with your actual search query.

Usage

To retrieve datasets based on a search query, make a POST request to the provided URL with the appropriate headers and payload. Ensure that you replace "query-text" with your desired search query.

curl -X POST "https://experiments.builtenvdata.eu/api/v1/datasets/search/" -H "Content-Type: application/json" -d '{ "query": "query-text" }'

Retrieve dataset by its ID

This API endpoint enables you to access detailed information about a dataset by providing its unique identifier (ID). Replace this placeholder `:dataset-id` , with the actual ID of the dataset you want to retrieve.

curl -X GET "https://experiments.builtenvdata.eu/api/v1/datasets/:dataset-id/"

Filesize in GB

This API allows you to retrieve the size of a dataset file in gigabytes (GB). Replace this placeholder ` :filename-without-extension ` with the actual filename (without extension) of the dataset file you want to retrieve the size for.

curl -X GET "https://experiments.builtenvdata.eu/api/v1/dataset-file/:filename-without-extension"

Download dataset zip file

This API allows you to download a dataset ZIP file associated with a specific dataset ID. By providing the dataset ID and the filename without extension, you can retrieve the dataset ZIP file.

Parameters

:dataset-id: Replace this placeholder with the actual ID of the dataset you want to download
:filename-without-extension: Replace this placeholder with the actual filename (without extension) of the dataset ZIP file you want to download.

To download the dataset ZIP file, make a GET request to the provided endpoint, replacing :dataset-id with the desired dataset ID and :filename-without-extension with the desired filename.

curl -X GET "https://experiments.builtenvdata.eu/api/v1/datasets/:dataset-id/download/:filename-without-extension"

Principal Investigators (PI) and associated datasets

This API allows you to retrieve detailed information about a Principal Investigator (PI) and assocaited datasets based on their unique slug identifier.

Parameters

:pi-slug: Replace this placeholder with the actual slug identifier of the PI you want to retrieve information for. The slug must be replaced by firstname - lastname , for example: `rui-pinho`

curl -X GET "https://experiments.builtenvdata.eu/api/v1/people/:pi-slug/"

Facility and associated datasets

This API allows you to retrieve detailed information about a facility and assocaited datasets based on its unique slug identifier.

Parameters

:facility-slug: Replace this placeholder with the actual slug identifier of the facility you want to retrieve information for. The slug must be replaced by facilityname -lab, for example: `eucentre-lab`

curl -X GET "https://experiments.builtenvdata.eu/api/v1/facility/:facility-slug/"

Country-specific facilities and associated datasets

This API allows you to retrieve information about facilities and associated datasets specific to a particular country. By providing the country name, you can obtain comprehensive details about facilities located in that country and the datasets associated with them, facilitating research planning, collaboration, and exploration of available resources within a specific geographical region.

Parameters

:country-name: Replace this placeholder with the name of the country for which you want to retrieve information about facilities and associated datasets.

curl -X GET "https://experiments.builtenvdata.eu/api/v1/country/:country-name/"

Taxonomy-related API requests

Material types for metadata filters

This API allows you to retrieve a list of material types categorized for metadata filtering. Each material type is associated with metadata filters that help in refining searches and organizing data efficiently.

curl -X GET "https://experiments.builtenvdata.eu/api/v1/taxonomy/get-material-types/"

Material type by its ID

This API enables you to fetch detailed information about a specific material type based on its unique identifier. Each material type is associated with metadata filters, facilitating efficient data organization and search refinement. To retrieve information about a material type by its ID, simply make a GET request to the provided endpoint, replacing :id with the desired material type ID.

curl -X GET "https://experiments.builtenvdata.eu/api/v1/taxonomy/get-material-types/:id/"

Specimen types for metadata filters

This API allows you to retrieve a list of specimen types categorized for metadata filtering. Each specimen type is associated with metadata filters that assist in refining searches and organizing data efficiently.

curl -X GET "https://experiments.builtenvdata.eu/api/v1/taxonomy/get-specimen-types/"

Specimen type by its ID

This API enables you to fetch detailed information about a specific specimen type based on its unique identifier. Each specimen type is associated with metadata filters, facilitating efficient data organization and search refinement. To retrieve information about a specimen type by its ID, simply make a GET request to the provided endpoint, replacing :id with the desired specimen type ID.

curl -X GET "https://experiments.builtenvdata.eu/api/v1/taxonomy/get-specimen-types/:id/"

Dataset DOI-related API requests

coming soon...