---
title: "POST /evaluate"
method: POST
path: "/evaluate"
tags: ["FAIR object"]
---

# POST /evaluate

`POST /evaluate`

Evaluate FAIRness of a data object based on its identifier

## Request body

- Body
  - `object_identifier` string, required — The full identifier of data object that needs to be evaluated
  - `test_debug` boolean — Indicate if the detailed evaluation procedure of the metrics should to be included in the response
  - `metadata_service_endpoint` string — The URL of the catalogue endpoint (e.g. OAI-PMH data-provider)
  - `metadata_service_type` string
  - `use_datacite` boolean — Indicates if DataCite content negotiation (using the DOI) shall be used to collect metadata
  - `use_github` boolean — Indicates if the GitHub REST API shall be used to collect (meta)data
  - `use_headless` boolean — Indicates if a headless brower should be used which is able to render Javascript generated content
  - `metric_version` string — The FAIRsFAIR metric version be used fo rthe assessment
  - `auth_token` string — The authentication token for HTTP authentication
  - `auth_token_type` string — The authentication token type, 'Basic' or 'Bearer'
  - `oaipmh_endpoint` string — (Deprecated) The URL of the OAI-PMH data-provider

## Response `200`

successful operation

- FAIRResults
  - `test_id` string
  - `request` object
  - `resolved_url` string
  - `start_timestamp` string, date-time
  - `end_timestamp` string, date-time
  - `metric_specification` string, uri
  - `metric_version` string
  - `software_version` string
  - `total_metrics` integer
  - `summary` object
  - `results` union[]
    - union
      - Uniqueness
        - `id` integer, required
        - `metric_identifier` string, required
        - `metric_name` string, required
        - `metric_tests` object
        - `test_status` 'pass' | 'fail' | 'indeterminate', required
        - `score` FAIRResultCommonScore, required
          - `earned` number
          - `total` number
        - `maturity` integer
        - `output` UniquenessOutput
          - `unique_identifiers` UniquenessOutputInner[]
            - `guid` string
            - `guid_scheme` string
            - `target` string
          - `guid` string
          - `guid_scheme` string
        - `test_debug` string[]
      - Persistence
        - `id` integer, required
        - `metric_identifier` string, required
        - `metric_name` string, required
        - `metric_tests` object
        - `test_status` 'pass' | 'fail' | 'indeterminate', required
        - `score` FAIRResultCommonScore, required
          - `earned` number
          - `total` number
        - `maturity` integer
        - `output` PersistenceOutput
          - `persistent_identifiers` PersistenceOutputInner[]
            - `pid` string
            - `pid_scheme` string
            - `resolvable_status` boolean
            - `resolved_url` string
            - `target` string
        - `test_debug` string[]
      - CoreMetadata
        - `id` integer, required
        - `metric_identifier` string, required
        - `metric_name` string, required
        - `metric_tests` object
        - `test_status` 'pass' | 'fail' | 'indeterminate', required
        - `score` FAIRResultCommonScore, required
          - `earned` number
          - `total` number
        - `maturity` integer
        - `output` CoreMetadataOutput
          - `core_metadata_status` 'insufficent metadata' | 'partial metadata' | 'all metadata'
          - `core_metadata_found` OutputCoreMetadataFound
          - `core_metadata_source` string[]
        - `test_debug` string[]
      - IdentifierIncluded
        - `id` integer, required
        - `metric_identifier` string, required
        - `metric_name` string, required
        - `metric_tests` object
        - `test_status` 'pass' | 'fail' | 'indeterminate', required
        - `score` FAIRResultCommonScore, required
          - `earned` number
          - `total` number
        - `maturity` integer
        - `output` IdentifierIncludedOutput
          - `object_identifier_included` string
          - `object_content_identifier_included` IdentifierIncludedOutputInner[]
            - `content_identifier_included` string
        - `test_debug` string[]
      - Searchable
        - `id` integer, required
        - `metric_identifier` string, required
        - `metric_name` string, required
        - `metric_tests` object
        - `test_status` 'pass' | 'fail' | 'indeterminate', required
        - `score` FAIRResultCommonScore, required
          - `earned` number
          - `total` number
        - `maturity` integer
        - `output` SearchableOutput
          - `search_mechanisms` OutputSearchMechanisms[]
            - `mechanism` 'metadata registry' | 'structured data'
            - `mechanism_info` string[]
        - `test_debug` string[]
      - DataAccessLevel
        - `id` integer, required
        - `metric_identifier` string, required
        - `metric_name` string, required
        - `metric_tests` object
        - `test_status` 'pass' | 'fail' | 'indeterminate', required
        - `score` FAIRResultCommonScore, required
          - `earned` number
          - `total` number
        - `maturity` integer
        - `output` DataAccessOutput
          - `access_level` 'public' | 'embargoed' | 'restricted' | 'closed' | 'metadataonly'
          - `access_details` object
        - `test_debug` string[]
      - FormalMetadata
        - `id` integer, required
        - `metric_identifier` string, required
        - `metric_name` string, required
        - `metric_tests` object
        - `test_status` 'pass' | 'fail' | 'indeterminate', required
        - `score` FAIRResultCommonScore, required
          - `earned` number
          - `total` number
        - `maturity` integer
        - `output` FormalMetadataOutputInner[]
          - `serialization_format` string
          - `source` 'typed_link' | 'content_negotiate' | 'structured_data' | 'sparql_endpoint'
          - `is_metadata_found` boolean
        - `test_debug` string[]
      - SemanticVocabulary
        - `id` integer, required
        - `metric_identifier` string, required
        - `metric_name` string, required
        - `metric_tests` object
        - `test_status` 'pass' | 'fail' | 'indeterminate', required
        - `score` FAIRResultCommonScore, required
          - `earned` number
          - `total` number
        - `maturity` integer
        - `output` SemanticVocabularyOutputInner[]
          - `namespace` string
          - `is_namespace_active` boolean
        - `test_debug` string[]
      - RelatedResource
        - `id` integer, required
        - `metric_identifier` string, required
        - `metric_name` string, required
        - `metric_tests` object
        - `test_status` 'pass' | 'fail' | 'indeterminate', required
        - `score` FAIRResultCommonScore, required
          - `earned` number
          - `total` number
        - `maturity` integer
        - `output` RelatedResourceOutputInner[]
          - `related_resource` string
          - `relation_type` string
        - `test_debug` string[]
      - DataContentMetadata
        - `id` integer, required
        - `metric_identifier` string, required
        - `metric_name` string, required
        - `metric_tests` object
        - `test_status` 'pass' | 'fail' | 'indeterminate', required
        - `score` FAIRResultCommonScore, required
          - `earned` number
          - `total` number
        - `maturity` integer
        - `output` DataContentMetadataOutput
          - `object_type` string
          - `data_content_descriptor` DataContentMetadataOutputInner[]
            - `descriptor` string
            - `descriptor_value` string
            - `matches_content` boolean
        - `test_debug` string[]
      - License
        - `id` integer, required
        - `metric_identifier` string, required
        - `metric_name` string, required
        - `metric_tests` object
        - `test_status` 'pass' | 'fail' | 'indeterminate', required
        - `score` FAIRResultCommonScore, required
          - `earned` number
          - `total` number
        - `maturity` integer
        - `output` LicenseOutputInner[]
          - `license` string
          - `OSI_approved` boolean
          - `details_url` string
        - `test_debug` string[]
      - DataProvenance
        - `id` integer, required
        - `metric_identifier` string, required
        - `metric_name` string, required
        - `metric_tests` object
        - `test_status` 'pass' | 'fail' | 'indeterminate', required
        - `score` FAIRResultCommonScore, required
          - `earned` number
          - `total` number
        - `maturity` integer
        - `output` DataProvenanceOutput
          - `provenance_metadata_included` DataProvenanceOutputInner
            - `is_available` boolean
            - `provenance_metadata` object[]
              - …
          - `structured_provenance_available` DataProvenanceOutputInner
            - `is_available` boolean
            - `provenance_metadata` object[]
              - …
        - `test_debug` string[]
      - CommunityEndorsedStandard
        - `id` integer, required
        - `metric_identifier` string, required
        - `metric_name` string, required
        - `metric_tests` object
        - `test_status` 'pass' | 'fail' | 'indeterminate', required
        - `score` FAIRResultCommonScore, required
          - `earned` number
          - `total` number
        - `maturity` integer
        - `output` CommunityEndorsedStandardOutputInner[]
          - `metadata_standard` string
          - `url` string
          - `subject_areas` string[]
          - `type` string
          - `source` string
        - `test_debug` string[]
      - DataFileFormat
        - `id` integer, required
        - `metric_identifier` string, required
        - `metric_name` string, required
        - `metric_tests` object
        - `test_status` 'pass' | 'fail' | 'indeterminate', required
        - `score` FAIRResultCommonScore, required
          - `earned` number
          - `total` number
        - `maturity` integer
        - `output` DataFileFormatOutputInner[]
          - `file_uri` string
          - `mime_type` string
          - `is_preferred_format` boolean
          - `preference_reason` string[]
          - `subject_areas` string[]
        - `test_debug` string[]
      - MetadataPreserved
        - `id` integer, required
        - `metric_identifier` string, required
        - `metric_name` string, required
        - `metric_tests` object
        - `test_status` 'pass' | 'fail' | 'indeterminate', required
        - `score` FAIRResultCommonScore, required
          - `earned` number
          - `total` number
        - `maturity` integer
        - `output` MetadataPreservedOutput
          - `metadata_preservation_method` string[]
        - `test_debug` string[]
      - CodeProvenance
        - `id` integer, required
        - `metric_identifier` string, required
        - `metric_name` string, required
        - `metric_tests` object
        - `test_status` 'pass' | 'fail' | 'indeterminate', required
        - `score` FAIRResultCommonScore, required
          - `earned` number
          - `total` number
        - `maturity` integer
        - `output` CodeProvenanceOutput
        - `test_debug` string[]
      - ComponentIdentifier
        - `id` integer, required
        - `metric_identifier` string, required
        - `metric_name` string, required
        - `metric_tests` object
        - `test_status` 'pass' | 'fail' | 'indeterminate', required
        - `score` FAIRResultCommonScore, required
          - `earned` number
          - `total` number
        - `maturity` integer
        - `output` ComponentIdentifierOutput
        - `test_debug` string[]
      - TestCase
        - `id` integer, required
        - `metric_identifier` string, required
        - `metric_name` string, required
        - `metric_tests` object
        - `test_status` 'pass' | 'fail' | 'indeterminate', required
        - `score` FAIRResultCommonScore, required
          - `earned` number
          - `total` number
        - `maturity` integer
        - `output` TestCaseOutput
        - `test_debug` string[]
      - UniquePersistentIdentifierSoftware
        - `id` integer, required
        - `metric_identifier` string, required
        - `metric_name` string, required
        - `metric_tests` object
        - `test_status` 'pass' | 'fail' | 'indeterminate', required
        - `score` FAIRResultCommonScore, required
          - `earned` number
          - `total` number
        - `maturity` integer
        - `output` UniquePersistentIdentifierSoftwareOutput
        - `test_debug` string[]
      - VersionIdentifier
        - `id` integer, required
        - `metric_identifier` string, required
        - `metric_name` string, required
        - `metric_tests` object
        - `test_status` 'pass' | 'fail' | 'indeterminate', required
        - `score` FAIRResultCommonScore, required
          - `earned` number
          - `total` number
        - `maturity` integer
        - `output` VersionIdentifierOutput
        - `test_debug` string[]
      - API
        - `id` integer, required
        - `metric_identifier` string, required
        - `metric_name` string, required
        - `metric_tests` object
        - `test_status` 'pass' | 'fail' | 'indeterminate', required
        - `score` FAIRResultCommonScore, required
          - `earned` number
          - `total` number
        - `maturity` integer
        - `output` APIOutput
        - `test_debug` string[]
      - DevelopmentMetadata
        - `id` integer, required
        - `metric_identifier` string, required
        - `metric_name` string, required
        - `metric_tests` object
        - `test_status` 'pass' | 'fail' | 'indeterminate', required
        - `score` FAIRResultCommonScore, required
          - `earned` number
          - `total` number
        - `maturity` integer
        - `output` DevelopmentMetadataOutput
        - `test_debug` string[]
      - Requirements
        - `id` integer, required
        - `metric_identifier` string, required
        - `metric_name` string, required
        - `metric_tests` object
        - `test_status` 'pass' | 'fail' | 'indeterminate', required
        - `score` FAIRResultCommonScore, required
          - `earned` number
          - `total` number
        - `maturity` integer
        - `output` RequirementsOutput
        - `test_debug` string[]
      - StandardisedProtocolData
        - `id` integer, required
        - `metric_identifier` string, required
        - `metric_name` string, required
        - `metric_tests` object
        - `test_status` 'pass' | 'fail' | 'indeterminate', required
        - `score` FAIRResultCommonScore, required
          - `earned` number
          - `total` number
        - `maturity` integer
        - `output` StandardisedProtocolOutput
          - `standard_protocol` StandardisedProtocolOutputInner[]
            - `protocol_type` string
            - `auth_method` string
            - `found_in` string
            - `target` string
        - `test_debug` string[]
      - StandardisedProtocolMetadata
        - `id` integer, required
        - `metric_identifier` string, required
        - `metric_name` string, required
        - `metric_tests` object
        - `test_status` 'pass' | 'fail' | 'indeterminate', required
        - `score` FAIRResultCommonScore, required
          - `earned` number
          - `total` number
        - `maturity` integer
        - `output` StandardisedProtocolOutput
          - `standard_protocol` StandardisedProtocolOutputInner[]
            - `protocol_type` string
            - `auth_method` string
            - `found_in` string
            - `target` string
        - `test_debug` string[]
      - Retrievable
        - `id` integer, required
        - `metric_identifier` string, required
        - `metric_name` string, required
        - `metric_tests` object
        - `test_status` 'pass' | 'fail' | 'indeterminate', required
        - `score` FAIRResultCommonScore, required
          - `earned` number
          - `total` number
        - `maturity` integer
        - `output` RetrievableOutput
          - `retrievable_objects` RetrievableOutputInner[]
            - `format` string
            - `method` string
            - `resolved_url` string
            - `target` string
        - `test_debug` string[]

## Other responses

- `400` — Invalid identifier supplied
- `401` — Authentication information is missing or invalid
- `404` — Object not found

---

[API](https://skmtc.net/pangaea-data-publisher/apis/f-uji.md) · [All operations](https://skmtc.net/pangaea-data-publisher/apis/f-uji/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pangaea-data-publisher/f-uji/versions/366a886a9acc/schema)