Skip to main content
POST
Test Mapping

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

size
integer
default:100

The number of rows to sample from the dataset. Defaults to 100 when omitted.

Required range: x <= 1000

Body

application/json
attribute_id
integer
required

The target attribute's ID.

dataset_id
integer
required

The source dataset's ID.

mapping
object
required

Mapping definition for create/update requests. Dependencies are computed server-side and not provided by the client.

status
enum<string> | null

Status to create the mapping in. Defaults to active when omitted. Narrower than MappingStatus — a mapping cannot be created already archived.

Available options:
active,
pending,
null
tags
string[] | null

Free-form labels on the mapping. Null and an empty array both mean no tags; nio:-prefixed tags are reserved for Narrative.

Example:
source
enum<string> | null

Optional source for the mapping. Null or omitted defaults to company. Only company and rosetta_stone are allowed for user-created mappings.

Available options:
company,
rosetta_stone,
null

Response

200 - application/json

OK

Sampled rows with the mapping applied, one object per row.

Every record carries both an input and an output. applyMapping builds each row by nesting the source columns under input and the mapped columns under output before serializing, so neither key is ever absent. Their contents are open maps: input is keyed by dataset field name and output by attribute name, both of which vary per request.

A cached_mapping is resolved as a join at query time and has no per-row preview, so records is empty for one.

records
object[]
required