API ReferenceMapping

Create a mapping between two schemas

Creates a list of mapping rules based on two provided schemas

Headers

AuthorizationstringRequired

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

X-Disable-Hooks"true"Required

Query parameters

environmentIdstringOptional
The ID of the environment

Request

This endpoint expects an object.
sourceobjectRequired
Source schema
destinationobjectRequired
Destination schema
familyIdstringOptional
ID of the family to add the program to
namespacestringOptional
Namespace of the program
savebooleanOptional
Whether to save the program for editing later. Defaults to false. If true, the response will contain an ID and access token.
ruleslist of objectsOptional
Mapping rules to use for the program. If present, the program will be created with these rules.

Response

This endpoint returns an object.
dataobject

Errors