v1

latestOpenAPI 3.0.1MIT License2026-07-1747628.8 KB
FAIR object

Evaluate FAIRness of a data object based on its identifier

post/evaluate

Request body

object_identifierstring required

The full identifier of data object that needs to be evaluated

test_debugboolean

Indicate if the detailed evaluation procedure of the metrics should to be included in the response

metadata_service_endpointstring

The URL of the catalogue endpoint (e.g. OAI-PMH data-provider)

metadata_service_typestring
use_dataciteboolean

Indicates if DataCite content negotiation (using the DOI) shall be used to collect metadata

use_githubboolean

Indicates if the GitHub REST API shall be used to collect (meta)data

use_headlessboolean

Indicates if a headless brower should be used which is able to render Javascript generated content

metric_versionstring

The FAIRsFAIR metric version be used fo rthe assessment

auth_tokenstring

The authentication token for HTTP authentication

auth_token_typestring

The authentication token type, 'Basic' or 'Bearer'

oaipmh_endpointstring

(Deprecated) The URL of the OAI-PMH data-provider

Response

successful operation

test_idstring
requestobject
resolved_urlstring
start_timestampstring date-time
end_timestampstring date-time
metric_specificationstring uri
metric_versionstring
software_versionstring
total_metricsinteger
summaryobject
All 4 operations