Exports

Check an export

Poll until status is completed, then follow download_url. download_url is absent until there is something to download, so readiness never has to be inferred from a status string next to a URL that would fail.

Statuses: queued, running, completed, failed. A failed export carries the machine error under error.

Required scope: any one of vessel:screen, cargo:screen, logs:read, whichever governs the resource you name.

get/api/v1/exports/{id}

Request

  • Base URL: https://arcnautical.com
  • URL: https://arcnautical.com/api/v1/exports/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-ArcNautical-Key
    • HTTP bearer
    • API key in header X-ArcNautical-Key
    • HTTP bearer
    • API key in header X-ArcNautical-Key

Path parameters

idstring uuid required

Export id.

Response

Successful response.

idstring uuid required
resource'screenings' | 'cargo_screenings' | 'access_log' | 'voyage_assessments' required

What to export. Each is governed by the same scope that governs reading it one record at a time: screenings by vessel:screen, cargo_screenings by cargo:screen, access_log by logs:read.

format'csv' | 'jsonl' required
status'queued' | 'running' | 'completed' | 'failed' required
filtersobject required

The filters as applied, including the pinned created_before.

estimated_row_countinteger nullable

Rows matched when the export was accepted.

row_countinteger nullable

Rows actually written. Null until completed.

byte_sizeinteger nullable
checksum_sha256string nullable

SHA-256 of the file body, hex.

download_urlstring

Present only when status is completed.

download_countinteger
downloaded_atstring date-time nullable
created_atstring date-time required
completed_atstring date-time nullable
expires_atstring date-time required

When the FILE is deleted. The records it was built from are unaffected.

Changes

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