Run Mapping Template

posthttps://api.flxpoint.com/mapping-template/run

Use this when you want to create mappingtemplate data through the API.

🔑 X-API-TOKEN⏱ 2 req/sToken: Account · Source · Channel

This page explains the endpoint. To send a live test request, use the interactive tester in Stoplight or your own Postman / HTTP client.

This endpoint will run a mapping template

Request

Bodyapplication/json

mappingEventIdintegerrequired

fromObjectsobjectrequired

No properties documented.

toObjectsobjectrequired

No properties documented.

optionsobject

skipNonExistentMethodsboolean

omitNullsboolean

skipFieldHandlesarray[string]

string

onlyRunFieldHandlesarray[string]

string

skipObjectHandlesarray[string]

string

onlyRunObjectHandlesarray[string]

string

customHandlersarray[RunMappingTemplateRequestCustomHandlers]

fieldHandleExactstring

fieldHandleMatchesRegExpstring

Example request

post/mapping-template/run

curl -X POST "https://api.flxpoint.com/mapping-template/run" \
  -H "Accept: application/json" \
  -H "X-API-TOKEN: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "mappingEventId": 0,
         "fromObjects": {},
         "toObjects": {},
         "options": {
           "skipNonExistentMethods": true,
           "omitNulls": true,
           "skipFieldHandles": [
             "string"
           ],
           "onlyRunFieldHandles": [
             "string"
           ],
           "skipObjectHandles": [
             "string"
           ],
           "onlyRunObjectHandles": [
             "string"
           ],
           "customHandlers": [
             {
               "fieldHandleExact": "string",
               "fieldHandleMatchesRegExp": "string"
             }
           ]
         }
       }'

Example body · application/json

{
  "mappingEventId": 0,
  "fromObjects": {},
  "toObjects": {},
  "options": {
    "skipNonExistentMethods": true,
    "omitNulls": true,
    "skipFieldHandles": [
      "string"
    ],
    "onlyRunFieldHandles": [
      "string"
    ],
    "skipObjectHandles": [
      "string"
    ],
    "onlyRunObjectHandles": [
      "string"
    ],
    "customHandlers": [
      {
        "fieldHandleExact": "string",
        "fieldHandleMatchesRegExp": "string"
      }
    ]
  }
}

Responses

200OKapplication/json

fromObjectsobjectrequired

No properties documented.

toObjectsobjectrequired

No properties documented.

customHandlersarray[RunMappingTemplateResponseCustomHandlers]

mappingFieldobject

idinteger

accountIdinteger

mappingEventIdinteger

mappingFieldTypeIdintegerrequired

toGlobalObjectFieldIdinteger

fromGlobalObjectFieldIdinteger

rawValuestring

mappingSetIdinteger

mappingSetNoMatchUseValueboolean

mappingSetNoMatchValuestring

toHeaderstring

fromHeaderstring

sortOrderinteger

attributeNamestring

customFieldNamestring

optionNamestring

imagePositioninteger

dateFormatstring

useCommaDecimalSeparatorboolean

mappingFieldTypeobjectrequired

idintegerrequired

handlestringrequired

allowedemptyfieldvalueheadermapping_setoptiondirect_copy

namestringrequired

rulesarray[MappingFieldRule]

idinteger

mappingFieldIdinteger

mappingRuleIdintegerrequired

mappingSetIdinteger

sortOrderinteger

customAggregateFieldHandlestring

Populate with CAF handle when mapping from a CAF

valueobject

No properties documented.

Example response

{
  "fromObjects": {},
  "toObjects": {},
  "customHandlers": [
    {
      "mappingField": {
        "id": 0,
        "accountId": 0,
        "mappingEventId": 0,
        "mappingFieldTypeId": 0,
        "toGlobalObjectFieldId": 0,
        "fromGlobalObjectFieldId": 0,
        "rawValue": "string",
        "mappingSetId": 0,
        "mappingSetNoMatchUseValue": true,
        "mappingSetNoMatchValue": "string",
        "toHeader": "string",
        "fromHeader": "string",
        "sortOrder": 0,
        "attributeName": "string",
        "customFieldName": "string",
        "optionName": "string",
        "imagePosition": 0,
        "dateFormat": "string",
        "useCommaDecimalSeparator": true,
        "mappingFieldType": {
          "id": null,
          "handle": null,
          "name": null
        },
        "rules": [
          null
        ],
        "customAggregateFieldHandle": "string"
      },
      "value": {}
    }
  ]
}

404Not Found

No schema documented for this status.

OpenAPI fragment

{
  "post": {
    "summary": "Run Mapping Template",
    "description": "This endpoint will run a mapping template",
    "parameters": [],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/RunMappingTemplateRequest"
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "OK",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/RunMappingTemplateResponse"
            }
          }
        }
      },
      "404": {
        "description": "Not Found"
      }
    }
  }
}

Ready to run it? Send the curl from your terminal or Postman, or use the interactive tester in Stoplight.Open in Stoplight