Use the
organization/elements/{keyOrId}/transformations endpoints to manage the transformations on element instances. GET /organizations/elements/{keyOrId}/transformations
Retrieve a list of the default organization-level transformations by element.
List Organization-Level Transformations by Element Path Parameters
| keyOrId | The element key, usually a lowercase version of the element name, or the element id, which is a numeric identifier of the element. |
List Organization-Level Transformations by Element Response Fields
| level | The level of the specified account, either organization, account, or instance. |
| objectName | The name of the new virtual data resource. |
| vendorName | The APIN provider's name of the resource that is mapped to the virtual data resource. |
| startDate | The date that the transformation was updated. |
| fields | An object containing the field names and data types of the virtual data resource. |
| fields.path | The name of the field. |
| fields.type | The data type of the field. |
| fields.vendorPath | The API provider's field name that the path is mapped to. |
| fields.level | The level at which the mapping exists, either organization, account, or instance. |
| configuration | An object containing the configuration of the virtual data resource. |
| configuration.type | The type of configuration. passThrough is the configuration for removing unmapped fields while inherit is a legacy configuration. |
| isLegacy | Indicates if the virtual data resource was created in Cloud Elements 2.0 (true) or earlier (false). |
List Organization-Level Transformations by Element Example Request
curl -X GET \
https://api.cloud-elements.com/elements/api-v2/organizations/elements/sfdc/transformations \
-H 'authorization: User sAfK7LJGNz5ZHcNrvdJvLI=f03WbTbH6aRKc0HJ3oOIi, Organization 58168435e3b9959a929eb04b6218b9a2' \
-H 'Content-Type: application/json' \
List Organization-Level Transformations by Element Example Response
{
"myContacts":{
"level":"organization",
"objectName":"myContacts",
"vendorName":"Contact",
"startDate":"2018-03-07 16:50:32.223761",
"fields":[
{
"type":"string",
"path":"address.city",
"vendorPath":"MailingCity",
"level":"organization"
},
{
"type":"string",
"path":"address.state",
"vendorPath":"MailingState",
"level":"organization"
},
{
"type":"string",
"path":"address.street",
"vendorPath":"MailingStreet",
"level":"organization"
},
{
"type":"string",
"path":"address.zip",
"vendorPath":"MailingPostalCode",
"level":"organization"
},
{
"type":"string",
"path":"firstName",
"vendorPath":"FirstName",
"level":"organization"
},
{
"type":"string",
"path":"id",
"vendorPath":"Id",
"level":"organization"
},
{
"type":"string",
"path":"lastName",
"vendorPath":"LastName",
"level":"organization"
},
{
"type":"boolean",
"path":"Deleted",
"vendorPath":"IsDeleted",
"level":"organization"
}
],
"configuration":[
{
"type":"passThrough",
"properties":{
"fromVendor":false,
"toVendor":false
}
},
{
"type":"inherit"
}
],
"isLegacy":false
}
}
GET /organizations/elements/{keyOrId}/transformations/{objectName}
Retrieve a list of the default organization-level transformations by element for a specific resource.
Retrieve Transformations for a Specific Organization Resource Path Parameters
| keyOrId | The element key, usually a lowercase version of the element name, or the element id, which is a numeric identifier of the element. |
| objectName | The name of the virtual data resource. |
Retrieve Transformations for a Specific Organization Resource Response Fields
| level | The level of the specified account, either organization, account, or instance. |
| objectName | The name of the new virtual data resource. |
| vendorName | The APIN provider's name of the resource that is mapped to the virtual data resource. |
| startDate | The date that the transformation was updated. |
| fields | An object containing the field names and data types of the virtual data resource. |
| fields.path | The name of the field. |
| fields.type | The data type of the field. |
| fields.vendorPath | The API provider's field name that the path is mapped to. |
| fields.level | The level at which the mapping exists, either organization, account, or instance. |
| configuration | An object containing the configuration of the virtual data resource. |
| configuration.type | The type of configuration. passThrough is the configuration for removing unmapped fields while inherit is a legacy configuration. |
| isLegacy | Indicates if the virtual data resource was created in Cloud Elements 2.0 (true) or earlier (false). |
Retrieve Transformations for a Specific Organization Resource Example Request
curl -X GET \
https://api.cloud-elements.com/elements/api-v2/organizations/elements/sfdc/transformations/myContacts \
-H 'authorization: User sAfK7LJGNz5ZHcNrvdJvLI=f03WbTbH6aRKc0HJ3oOIi, Organization 58168435e3b9959a929eb04b6218b9a2' \
-H 'Content-Type: application/json' \
Retrieve Transformations for a Specific Organization Resource Example Response
{
"myContacts":{
"level":"organization",
"objectName":"myContacts",
"vendorName":"Contact",
"startDate":"2018-03-07 16:50:32.223761",
"fields":[
{
"type":"string",
"path":"address.city",
"vendorPath":"MailingCity",
"level":"organization"
},
{
"type":"string",
"path":"address.state",
"vendorPath":"MailingState",
"level":"organization"
},
{
"type":"string",
"path":"address.street",
"vendorPath":"MailingStreet",
"level":"organization"
},
{
"type":"string",
"path":"address.zip",
"vendorPath":"MailingPostalCode",
"level":"organization"
},
{
"type":"string",
"path":"firstName",
"vendorPath":"FirstName",
"level":"organization"
},
{
"type":"string",
"path":"id",
"vendorPath":"Id",
"level":"organization"
},
{
"type":"string",
"path":"lastName",
"vendorPath":"LastName",
"level":"organization"
},
{
"type":"boolean",
"path":"Deleted",
"vendorPath":"IsDeleted",
"level":"organization"
}
],
"configuration":[
{
"type":"passThrough",
"properties":{
"fromVendor":false,
"toVendor":false
}
},
{
"type":"inherit"
}
],
"isLegacy":false
}
}
POST /organizations/elements/{keyOrId}/transformations/{objectName}
Create a default account-level transformation of an element for a specific virtual data resource.
Note: You cannot create a field in the virtual data resource and map a default transformation with this request. The fields must already exist in the virtual data resource.
Create a Default Organization-Level Transformation Path Parameters
| keyOrId | The element key, usually a lowercase version of the element name, or the element id, which is a numeric identifier of the element. |
| objectName | The name of the virtual data resource. |
Create a Default Organization-Level Transformation Request Body Parameters
| level | The level of the specified account, either organization, account, or instance. | Optional |
| objectName | An object containing the field names and data types of the common resource. | Optional |
| vendorName | The API provider's name of the resource that is mapped to the virtual data resource. | Required |
| fields | An object containing the field names and data types of the virtual data resource. | Required |
| level | The level at which the mapping exists, either organization, account, or instance.With an account-level API request, you can use only accountor instance. | Optional |
| fields.type | The data type of the field. | Required |
| fields.path | The name of the field. | Required |
| fields.vendorPath | The API provider's field name that the path is mapped to. | Required |
| fields.level | The level at which the mapping exists, either organization, account, or instance.With an account-level API request, you can use only accountor instance. | Required |
| configuration | An object containing the configuration of the virtual data resource. | Optional |
| configuration.properties | An object containing the configuration properties of the virtual data resource. | Optional |
| configuration.type | The type of configuration. passThrough is the configuration for removing unmapped fields while inherit is a legacy configuration. | Optional |
| configuration.properties.key | Configuration properties of the transformation. For passThrough, properties are:inherit, use only false or no value. | Optional |
Create a Default Organization-Level Transformation Example Request
curl -X POST \ https://api.cloud-elements.com/elements/api-v2/organizations/elements/sfdc/transformations/myContacts \-H 'authorization: User sAfK7LJGNz5ZHcNrvdJvLI=f03WbTbH6aRKc0HJ3oOIi, Organization 58168435e3b9959a929eb04b6218b9a2' \-H 'Content-Type:application/json' \ -d '{ "vendorName":"Contact", "fields":[ { "type":"string", "path":"lastName", "vendorPath":"LastName","level":"organization" } ], "configuration":[ { "type":"passThrough", "properties":{ "fromVendor":false, "toVendor":false } } ] }'
Create a Default Organization-Level Transformation Example Response
{
"myContacts":{
"level":"organization",
"objectName":"myContacts",
"vendorName":"Contact",
"startDate":"2018-03-07 16:50:32.223761",
"fields":[
{
"type":"string",
"path":"address.city",
"vendorPath":"MailingCity",
"level":"organization"
},
{
"type":"string",
"path":"address.state",
"vendorPath":"MailingState",
"level":"organization"
},
{
"type":"string",
"path":"address.street",
"vendorPath":"MailingStreet",
"level":"organization"
},
{
"type":"string",
"path":"address.zip",
"vendorPath":"MailingPostalCode",
"level":"organization"
},
{
"type":"string",
"path":"firstName",
"vendorPath":"FirstName",
"level":"organization"
},
{
"type":"string",
"path":"id",
"vendorPath":"Id",
"level":"organization"
},
{
"type":"string",
"path":"lastName",
"vendorPath":"LastName",
"level":"organization"
},
{
"type":"boolean",
"path":"Deleted",
"vendorPath":"IsDeleted",
"level":"organization"
}
],
"configuration":[
{
"type":"passThrough",
"properties":{
"fromVendor":false,
"toVendor":false
}
},
{
"type":"inherit"
}
],
"isLegacy":false
}
}PUT /organizations/elements/{keyOrId}/transformations/{objectName}
Replace a default organization-level transformation of an element for a specific virtual data resource. Replacing fields removes existing transformations, but not the virtual data resources.
Replace a Default Organization-Level Transformation Path Parameters
| keyOrId | The element key, usually a lowercase version of the element name, or the element id, which is a numeric identifier of the element. |
| objectName | The name of the virtual data resource. |
Replace a Default Organization-Level Transformation Request Body Parameters
| level | The level of the specified account, either organization, account, or instance. | Optional |
| objectName | An object containing the field names and data types of the common resource. | Optional |
| vendorName | The API provider's name of the resource that is mapped to the virtual data resource. | Required |
| fields | An object containing the field names and data types of the virtual data resource. | Required |
| level | The level at which the mapping exists, either organization, account, or instance.With an account-level API request, you can use only accountor instance. | Optional |
| fields.type | The data type of the field. | Required |
| fields.path | The name of the field. | Required |
| fields.vendorPath | The API provider's field name that the path is mapped to. | Required |
| fields.level | The level at which the mapping exists, either organization, account, or instance.With an account-level API request, you can use only accountor instance. | Required |
| configuration | An object containing the configuration of the virtual data resource. | Optional |
| configuration.properties | An object containing the configuration properties of the virtual data resource. | Optional |
| configuration.type | The type of configuration. passThrough is the configuration for removing unmapped fields while inherit is a legacy configuration. | Optional |
| configuration.properties.key | Configuration properties of the transformation. For passThrough, properties are:inherit, use only false or no value. | Optional |
Replace a Default Organization-Level Transformation Example Request
curl -X PUT \
https://api.cloud-elements.com/elements/api-v2/organizations/elements/sfdc/transformations/myContacts \
-H 'authorization: User sAfK7LJGNz5ZHcNrvdJvLI=f03WbTbH6aRKc0HJ3oOIi, Organization 58168435e3b9959a929eb04b6218b9a2' \
-H 'Content-Type:application/json' \
-d '{
"vendorName":"Contact",
"fields":[
{
"type":"string",
"path":"salutation",
"vendorPath":"Salutation"
}
],
"configuration":[
{
"type":"passThrough",
"properties":{
"fromVendor":false,
"toVendor":false
}
}
]
}'
Replace a Default Organization-Level Transformation Example Response
{
"myContacts":{
"level":"organization",
"objectName":"myContacts",
"vendorName":"Contact",
"startDate":"2018-03-07 16:50:32.223761",
"fields":[
{
"type":"string",
"path":"salutation",
"vendorPath":"Salutation",
"level":"account"
}
],
"configuration":[
{
"type":"passThrough",
"properties":{
"fromVendor":false,
"toVendor":false
}
},
{
"type":"inherit"
}
],
"isLegacy":false
}
}DELETE /organizations/elements/{keyOrId}/transformations
Delete all organization-level transformations for a specific element.
Delete All Organization Transformations for a Specific Element Path Parameters
| keyOrId | The element key, usually a lowercase version of the element name, or the element id, which is a numeric identifier of the element. |
Delete All Organization Transformations for a Specific Element Example Request
curl -X DELETE \
https://api.cloud-elements.com/elements/api-v2/organizations/elements/{{keyOrId}}
Delete All Organization Transformations for a Specific Element Example Response
A response with a 200 Status Code indicates success. You can confirm that you deleted the transformations with GET /organizations/elements/{keyOrId}/transformations.
DELETE /organizations/elements/{keyOrId}/transformations/{objectName}
Delete account-level transformations for a specific virtual data resource and specific element.
Delete Organization Transformations for a VDR Path Parameters
| keyOrId | The element key, usually a lowercase version of the element name, or the element id, which is a numeric identifier of the element. |
| objectName | The name of the virtual data resource. |
Delete Organization Transformations for a VDR Example Request
curl -X DELETE \
https://api.cloud-elements.com/elements/api-v2/organizations/elements/sfdc/transformations/myContacts \
-H 'authorization: User sAfK7LJGNz5ZHcNrvdJvLI=f03WbTbH6aRKc0HJ3oOIi, Organization 58168435e3b9959a929eb04b6218b9a2' \
-H 'content-type: application/json' \
Delete Organization Transformations for a VDR Example Response
A response with a 200 Status Code indicates success. You can confirm that you deleted the transformations with GET /organizations/elements/{keyOrId}/transformations.
