Skip to content

mapping.list ​

Lists every mapping in the model, with the dimensions on each side.

js
mapping.list()

Returns ​

array

The mappings, each with:

  • name and id: the mapping's name and id.
  • dimensions_left and dimensions_right: the names of the dimensions on each side.
  • left_allows_many and right_allows_many: whether each side can have more than one row for the same keys.

It's an array, not a JSON string, so there's no need for JSON.parse().

Examples ​

js
const mappings = mapping.list();
json
[
    {
        "name": "Time to Year and Month",
        "id": "3f2a9c1e8b7d4f60a1c2e3d4b5a69788",
        "dimensions_left": ["Time"],
        "dimensions_right": ["Year", "Month"],
        "left_allows_many": false,
        "right_allows_many": false
    }
]