FAIR object

POST /evaluate

Evaluate FAIRness of a data object based on its identifier

Request

Base URL
http://localhost:1071/fuji/api/v1
Auth
HTTP basic
TypeScript
https://skmtc.dev/pangaea-data-publisher/apis/f-uji/docs/evaluate/post.ts
A function with typed inputs. Its response is checked against the schema.

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

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

May 29, 2026366a886a9acc Revision changes
- info
  added the new optional request property
Jan 14, 2026db2f07c1ee60 Revision changes
- warning
  removed the optional property from the response with the status