Element and Formula Instance Account APIs

GET /accounts/instances

GET /accounts/{id}/instances

Retrieve a list of the authenticated element instances associated with an account. 

The endpoints to retrieve element instances by account are:

• GET /accounts/instances
  • Retrieve a list of authenticated element instances based on the account associated with the logged in user or the Organization and User Secret passed with the request
• GET/accounts/{id}/instances
  • Retrieve a list of authenticated element instances within an account by passing the account id with the request.

List Element Instances Path Parameters

Only used for GE/accounts/{id}/instances.

List Element Instances Response Fields

See the element/instances documentation.

GET /accounts/instances Example Request

curl -X GET \
  https://api.cloud-elements.com/elements/api-v2/accounts/instances \ 
  -H 'authorization: User sAfK7LJGNz5ZHcNrvdJvLI=f03WbTbH6aRKc0HJ3oOIi, Organization 58168435e3b9959a929eb04b6218b9a2' \
  -H 'Content-Type: application/json' \

GET /accounts/{id}/instances Example Request

curl -X GET \
https://api.cloud-elements.com/elements/api-v2/accounts/156162/instances\
-H 'authorization: User sAfK7LJGNz5ZHcNrvdJvLI=f03WbTbH6aRKc0HJ3oOIi, Organization 58168435e3b9959a929eb04b6218b9a2' \
-H 'Content-Type: application/json' \

List Element Instances Example Response

{  
  "id":471196,
  "name":"MyElement",
  "token":"ABC/Dxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "element":{  
    "id":23,
    "name":"Salesforce Sales Cloud",
    "key":"sfdc",
    "image":"elements/provider_sfdc.png",
    "deleted":false,
    "typeOauth":true,
    "trialAccount":false,
    "transformationsEnabled":false,
    "bulkDownloadEnabled":false,
    "bulkUploadEnabled":false,
    "cloneable":false,
    "extendable":false,
    "beta":false,
    "extended":false
  },
  "elementId":23,
  "valid":true,
  "disabled":false,
  "maxCacheSize":0,
  "cacheTimeToLive":0,
  "configuration":{  

  },
  "eventsEnabled":false,
  "traceLoggingEnabled":false,
  "cachingEnabled":false,
  "externalAuthentication":"none",
  "user":{  
    "id":178542
  }
}

GET /accounts/{id}/formulas/{formulaId}/instances

Retrieve a list of the formula instances associated with a formula template within a specific account.

List Formula Instances Path Parameters

List Formula Instances Response Fields

See the element/instances documentation.

List Formula Instances Example Request

curl -X GET \
  https://api.cloud-elements.com/elements/api-v2/accounts/156162/formulas/4078/istances/ \ 
  -H 'authorization: User sAfK7LJGNz5ZHcNrvdJvLI=f03WbTbH6aRKc0HJ3oOIi, Organization 58168435e3b9959a929eb04b6218b9a2' \
  -H 'Content-Type: application/json' \

List Formula Instances Example Response

[  
  {  
    "id":30717,
    "formula":{  
      "id":4078,
      "active":true,
      "debugLoggingEnabled":true,
      "singleThreaded":false
    },
    "name":"test",
    "createdDate":"2017-09-19T19:24:47Z",
    "active":true,
    "settings":{  

    },
    "configuration":{  
      "destinationInstance":"438535",
      "originInstance":"438534"
    }
  }
]