Knowledgebase

Tips and tricks to work with resources and transformations

Articles

How Does the PUT and GET Calls Work for "/instances/{id}/objects/{objectName}/definitions"?
The GET API call for object definitions from the /instances path looks for an object definition at the instance level or above. Therefore, if there is no instance level but there is an account or organization level, it returns those definitions....
Transforming POST Virtual Data Resource Responses Using Javascript
allow you to transform data you're receiving from vendors (GET), as well as the format of data you send to the vendor (POST/PATCH/PUT). However, if you need to transform the response of a POST request, you can do that by adding Custom JS to you...
Custom JavaScript Transformations on Virtual Data Resources
Custom JavaScript can be used to manipulate fields from a transformation object to fit the structure and format of a in ways that cannot be achieved through mapping. Suppose that your transformation's contact object has the individual fields f...
How Can I Retrieve all the Field Levels of my Transformation?
We understand that from time to time, we will have a transformation on a virtual data resource that inherits multiple different field levels (such as organization, account, and instance levels). At times, it can get tricky to manage all the differen...
How do I Create a Transformation with an Array?
When defining a with an array, use the following format: keyToArray[*].keyToValuesInArray This will result in: { "keyToArray": [ “keyToValuesInArray”: “1”, “keyToValuesInArray”: “2" ] }...
Exporting and Importing Transformations and Objects between Environments
Imagine a quick scenario: I have built all of my integrations in the Staging environment and now I am ready to go into Production. However, in addition to my instances, I want to transfer over all the transformations I have created.  How do I...
How to Properly Export your Transformation using Cloud Elements 2.0
You have created a and mapped fields to it to create a transformation. Now you want to export it to share across your organization and/or different accounts. Here is a quick guide on how to properly export a . Log in to the platform environment w...
JS Transformations: How Do I Use the transformedObject Variable?
When doing a JavaScript transformation the transformedObject always represents the final state of the object when you are POSTing or GETting.  IMPORTANT: Do not define in your object definition or map in your transformation any fields that ...
How can Sub-resources be Transformed?
Transformations can be mapped to sub-resources (children) of objects, but it is important to know that transformed sub-resources are not added to the API Docs. To accomplish this task, you have to create a and transformation to the sub-object withi...
What API can be used to update an existing transformation?
To update an existing transformation via the API, use: PUT /instance/{instanceId}/transformations/{objectName}.