v1

latestOpenAPI 3.0.32026-07-12124032.8 KB
mappings

executeMapping

Execute entity mapping based on a config

post/v1/mappings:execute

Query parameters

preview_modeboolean
Example:true

True, if you want to preview the entities which will result

Request body

Example request

{
  "source_ref": {
    "entity_schema": "submission"
  },
  "loop_ref": {
    "entity_schema": "submission"
  },
  "targets": [
    {
      "mapping_attributes": [
        {
          "target": "_tags",
          "operation": {
            "_append": [
              "new",
              "tags"
            ],
            "_uniq": true
          }
        }
      ]
    }
  ]
}

Response

The target entities which were mapped

Example response

{
  "failures": [
    {
      "target": {
        "mapping_attributes": [
          {
            "target": "_tags",
            "operation": {
              "_append": [
                "new",
                "tags"
              ],
              "_uniq": true
            }
          }
        ]
      }
    }
  ]
}