Skip to main content
POST
Download mapping data as CSV

Restrictions

Usage

  • The response is a CSV stream (Content-Type: application/octet-stream), not JSON. The file name in Content-Disposition is the schema name with spaces replaced by _.
  • The first row lists source_labels followed by result_labels; each following row is one data row, most recently written first.
  • The schema must exist and not be deleted; otherwise a JSON InvalidParameter error is returned.

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

Body

application/json
schema_id
string
required

Mapping schema ID (MongoDB ObjectID hex).

Response

Success. CSV attachment stream, not a JSON envelope.

CSV file stream (Content-Type: application/octet-stream, Content-Disposition: attachment; filename=<schema_name>.csv). The header row lists the schema's source_labels followed by result_labels in order; each subsequent row is one mapping document.