Audit a published Darwin Core archive

A file this tool reads, sent or fetched from the address given, is read as one dropped on our website: what the read finds (column headings, the shape of its rows, the terms they became, refusal codes) is kept so the reader learns, never the file or its values. Names and contacts are dropped or replaced by a code, and protected species' locations are made coarser. The defects the website's own audit finds in a published Darwin Core archive, given by its GBIF dataset key or its address: each coded, with the check that found it, the file and lines it stands on and its count over the rows read; and every TDWG BDQ TG2 test, ran with its counts or not run under a code (a test not run is not a test passed). With call_id instead: a pending audit, collected.

get/audit

Request

  • Base URL: https://passage-data.com/api/v1
  • URL: https://passage-data.com/api/v1/audit
  • Auth: one of:
    • none
    • HTTP bearer
    • API key in header x-api-key

Query parameters

gbif_datasetstring uuid

A GBIF dataset key; the archive is fetched from the endpoint GBIF's registry lists.

urlstring uri

The http(s) address of a Darwin Core archive (up to 200 MB).

annexboolean

Also return the audit as a markdown document.

call_idstring

A pending audit's call_id: collect it (202 while it runs).

Response

The audit: defects by check with file, lines and count; every BDQ TG2 test ran or not run

archiveobject

source (gbif, url, upload), dataset (GBIF's registry entry), url, bytes, sha256, core, extensions, read

scopeobject

rows_read, rows_in_file, complete, columns_read, columns_unmapped, reads

bdqobject

standard, unit, file, records, summary, ran (test, terms, compliant, not_compliant, prerequisites_not_met, file, lines, values), not_run by code

keptobject
saysstring

Changes

No recorded changes to this operation across all 1 revision of this API.