The docs are moving!

Find us at our new Help Center where we've combined our documentation and knowledgebase articles in one easy-to-search location.

We aren't updating the Developer Portal anymore, except for the Element Docs — all updates happen in the Help Center. We're retiring the Developer Portal as you know it in:

Migrate Common Resources

If you are developing in multiple environments or accounts, you might need to move your common resources and transformations from one account or environment to another. You can use the organizations APIs to do this.

Migrate Common Resources

Migrating common resources is a two step process where you first get the common resource definition from one account or environment, and then post it to another.

Note: Sub-objects appear differently depending on how you created them, as common resources or as My Objects in Element Mapper. If you created them with Element Mapper, they are identified by a custom type and are stored as separate objects with the same name as the type value. For example, a sub-object called address will appear in the definition as:

{
  "type":"address"
  "path":"address"
}

Sub-objects created as common resources are shown in dot notation, e.g., "path": "Address.street".

To migrate common resources:

In the source account or environment, call GET /organizations/objects/{objectName}/definitions, replacing {objectName} with the name of the common resource.

Note: Use GET /organizations/objects/definitions to get the list of all common resources.

The JSON response looks like this:

{
  "fields": [
    {
      "type": "string",
      "path": "birthdate"
    },
    {
      "type": "string",
      "path": "FirstName"
    },
    {
      "type": "string",
      "path": "id"
    },
    {
      "type": "string",
      "path": "LastName"
    }
  ],
  "level": "organization"
}

Optional. If you created your common resource in an earlier version of the software, it might include a sub-object that it is stored separately. Run the call again using the name of the sub-object for {objectName}.
In your target account or environment, make a POST /organizations/objects/definitions API call, replacing objectName with the name of the common resource, and the fields object with the fields object from the previous step.

{
  "<objectName>": {
    "fields": [
      {
        "type": "string",
        "path": "birthdate"
      },
      {
        "type": "string",
        "path": "FirstName"
      },
      {
        "type": "string",
        "path": "id"
      },
      {
        "type": "string",
        "path": "LastName"
      }
    ]
  }
}

Migrate Transformations

Migrating transformations is a two step process where you first get the transformations definition from one account or environment, and then post it to another.

To migrate transformations:

In the source account or environment, call GET /organizations/elements/{keyOrId}/transformations/{objectName}, replacing keyOrId with the element key and {objectName} with the name of the common resource.

The JSON response looks like this:

{
  "level":"organization",
  "objectName":"myContacts_API",
  "vendorName":"Contact",
  "startDate":"2017-04-24 21:05:05.51129",
  "fields":[
    {
      "type":"string",
      "path":"birthdate",
      "vendorPath":"Birthdate",
      "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"
    }
  ],
  "configuration":[
    {
      "type":"passThrough",
      "properties":{
        "fromVendor":false,
        "toVendor":false
      }
    },
    {
      "type":"inherit"
    }
  ],
  "isLegacy":false
}

In your target account or environment, make a POST /organizations/elements/{keyOrId}/transformations/{objectName} API call, replacing keyOrId with the element key and objectName with the name of the common resource. Include the JSON payload from the previous step.