Skip to main content
POST
List mapping data

Restrictions

Usage

  • The schema must exist and not be deleted; otherwise InvalidParameter.
  • query filters by exact source label values. Keys that are not source labels are dropped; if any key remains, every source label must be given, otherwise InvalidParameter.
  • Page-based navigation (p, limit) reaches at most 10,000 rows (p * limit <= 10000); go further with search_after_ctx.
  • total counts at most 1,000 matching rows; used_cnt is the schema’s full row count.

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).

query
object

Exact-match filter on source label values. Keys that are not source labels of the schema are silently ignored; if any source label is given, all source labels must be provided.

orderby
enum<string>

Sort field. Defaults to updated_at.

Available options:
created_at,
updated_at
asc
boolean
default:false

Sort ascending when true; defaults to false (newest first).

p
integer<int64> | null

Page number (1-based) for offset pagination; defaults to 1 when omitted, null, or 0. Ignored when search_after_ctx is set. Page-based navigation can reach at most 10,000 rows (p * limit <= 10000).

Required range: x >= 0
limit
integer<int64> | null

Page size (0–100); defaults to 20 when omitted, null, or 0.

Required range: 0 <= x <= 100
search_after_ctx
string | null

Opaque cursor for cursor-based pagination — pass the search_after_ctx value from the previous response. Must be a MongoDB ObjectID hex string; when set, p is ignored.

Response

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

Operation-specific payload, documented in each operation's 200 response. Operations without a payload return {} or omit data entirely.