Mappings

Maximum number of mappings that will be returned in a single response. If there are more mappings, the response will contain a field next_page_token that will allow you to retrieve them.

A token that allows you to retrieve the next page of mappings. It should have the same value as the next_page_token-field you received in your last response.

If true, each mapping will only contain metadata fields; no mapping expressions, source and target schema, or lookup tables. If false, each mapping will contain all available fields. The metadata fields are id, name, type, created_at, and updated_at.

The mapping type, which determines the fields that show up in the output.

A schema describing the shape of the input JSON. The schema is not used to map documents, but it can provide valuable assistance while writing mapping expressions in the Mappings UI. The schema can include a default document with values that, also, can be helpful while writing mapping expressions. If you don't plan on editing the mapping definition using the UI, there's no benefit to including a source schema.

A schema describing the shape of the output JSON. The schema is not used to map documents, but in the Mappings UI, you can only write mapping expressions for fields that are present in the target schema.

The schema can include a default document. When mapping_type is set to merge_with_target_example, the values in this document are used as defaults, i.e. if a mapping expressions doesn't produce a value for a given field, the default value is used. For the mapping type merge_with_target_example, providing a target schema with a default document is mandatory. For all other mapping types, the default document is ignored and the entire target schema is optional.

If you don't plan on editing the mapping definition using the UI, and you're using a mapping type other than merge_with_target_example, there's no benefit to including a target schema.

A JSONata document describing the mapping expressions. For example:

{
  "total": item.quantity * item.unit_price,
  "currency": item.currency,
  "product": product.id
}

The JSONata document must be converted to a string, so in practice, it doesn't look like the above; it looks like this:

"{ \"total\": item.quantity * item.unit_price, \"currency\": item.currency, \"product\": product.id }"

A list of lookup tables that the mapping expressions in this mapping definition can use.

A lookup table is often used to convert a value from one format to another. For example, you can have a list of currencies with a short name, a full name, and a symbol for each currency, like this:

In a mapping expression, you can use the $lookupTable function to convert a value from one format to the other.

The mapping type, which determines the fields that show up in the output.

A schema describing the shape of the input JSON. The schema is not used to map documents, but it can provide valuable assistance while writing mapping expressions in the Mappings UI. The schema can include a default document with values that, also, can be helpful while writing mapping expressions. If you don't plan on editing the mapping definition using the UI, there's no benefit to including a source schema.

A schema describing the shape of the output JSON. The schema is not used to map documents, but in the Mappings UI, you can only write mapping expressions for fields that are present in the target schema.

The schema can include a default document. When mapping_type is set to merge_with_target_example, the values in this document are used as defaults, i.e. if a mapping expressions doesn't produce a value for a given field, the default value is used. For the mapping type merge_with_target_example, providing a target schema with a default document is mandatory. For all other mapping types, the default document is ignored and the entire target schema is optional.

If you don't plan on editing the mapping definition using the UI, and you're using a mapping type other than merge_with_target_example, there's no benefit to including a target schema.

A JSONata document describing the mapping expressions. For example:

{
  "total": item.quantity * item.unit_price,
  "currency": item.currency,
  "product": product.id
}

The JSONata document must be converted to a string, so in practice, it doesn't look like the above; it looks like this:

"{ \"total\": item.quantity * item.unit_price, \"currency\": item.currency, \"product\": product.id }"

A list of lookup tables that the mapping expressions in this mapping definition can use.

A lookup table is often used to convert a value from one format to another. For example, you can have a list of currencies with a short name, a full name, and a symbol for each currency, like this:

In a mapping expression, you can use the $lookupTable function to convert a value from one format to the other.