Transform documents

circle-exclamation

Transform documents contain the instructions on how to translate requests and responses to be compatible with the Spark Execute API.

Create new transform documents

  1. Transform files should be saved as JSON files with filenames ending with _transform.json.

  2. Navigate into the Folder overview page for your target destination folder.

  3. Choose the Transforms tab.

  4. Click New Transform.

    1. You can upload a pre-defined transform document. This must conform to the specifications in Define transform document and to any specific requirements for the transform being used.

    2. Create a new transform within Spark. From the UX you have the ability to choose the Transform type, Target API version and provide the code for the request and response transforms.

This new method replaces the previous approach of using Options Files to save transforms to apps/transforms.

Manage transform documents

Transforms can be managed from the Folder overview page in the Transforms tab. You can add, update, edit, and delete transforms through the user interface.

This can also be done using Transform documents APIs.

Define transform document

Transform documents will vary depending on the Transform types being used.

Last updated