{"basePath":"/elements/api-v2","paths":{"/abandoned-checkouts":{"get":{"operationId":"getAbandonedCheckouts","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The number of results to fetch in a given page. When this parameter is omitted, a maximum of 200 results are returned.","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/AbandonedCheckout"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve abandoned checkouts from the eCommerce system.","tags":["ecommerce"]}},"/accounts":{"get":{"operationId":"getAccounts","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for accounts last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all accounts are returned in a paginated fashion.","in":"query","name":"where","required":false,"type":"string"},{"description":"The page size for pagination, which defaults to 200 if not supplied","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"Specify if deleted accounts should be included in the search.","in":"query","name":"includeDeleted","required":false,"type":"boolean"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/Account"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Find accounts in the Marketing Automation system, using the provided CEQL search expression. The search expression in CEQL is the WHERE clause in a typical SQL query, but without the WHERE keyword. For example, to search for all accounts whose name contains the word 'data', the search expression parameter will be where=name like '%data%'. If a search expression is not provided, then the first 200 records will be returned.

If a value of true is specified for the includeDeleted flag, then any soft-deleted records will also be considered in the searched records.","tags":["marketing"]},"post":{"operationId":"createAccount","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The account object to be created.
With the exception of the 'id' field, the required fields indicated in the 'Account' model are those required to create a new account.","in":"body","name":"account","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Create a new account in the Marketing Automation service. Account creation will flow through Cloud Elements to your Marketing Automation service. With the exception of the 'id' field, the required fields indicated in the 'Account' model are those required to create a new account.","tags":["marketing"]}},"/accounts/instances":{"get":{"operationId":"getAccountsInstances","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"},{"description":"The page size. Defaults to 200 if not provided. Maximum of 200","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/ElementInstance"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Finds all instances for the default users' account","tags":["accounts"]}},"/accounts/objects/definitions":{"delete":{"operationId":"deleteAccountsObjectsDefinitions","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Delete all object definitions within the default users' account. If no object definitions exist then this will result in an error response.","tags":["accounts"]},"get":{"operationId":"getAccountsObjectsDefinitions","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Dictionary"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve all of the object definitions within the users' default account. Specifying an object definition that does not exist will result in an error response.","tags":["accounts"]},"post":{"operationId":"createAccountObjectDefinition","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The object definitions to create","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Dictionary"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Dictionary"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Create multiple object definitions within this users' default account. The definitions allow you to define what an object looks like within an account.","tags":["accounts"]}},"/accounts/objects/{objectName}/definitions":{"delete":{"operationId":"deleteAccountsObjectsObjectNameDefinitions","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Delete an object definition associated with an objectName within the default users' account. Specifying an object name that does not have an object definition will result in an error response.","tags":["accounts"]},"get":{"operationId":"getAccountsObjectsObjectNameDefinitions","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Definition"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve a specific object definition associated with an objectName within the default users' account. Specifying an object definition associated with a given objectName that does not exist will result in an error response.","tags":["accounts"]},"post":{"operationId":"createAccountObjectObjectNameDefinition","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The object definition","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Definition"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Definition"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Create a new object definition associated with an objectName within the users' default account. The definitions allow you to define what an object looks like within an account.","tags":["accounts"]},"put":{"operationId":"replaceAccountsObjectsObjectNameDefinitions","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The object definition","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Definition"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Definition"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Update a specific object's definition associated with an objectName within the default users' account. Specifying an object definition associated with a given objectName that does not exist will result in an error response.","tags":["accounts"]}},"/accounts/{accountId}":{"delete":{"operationId":"deleteAccountByAccountId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The account ID","in":"path","name":"accountId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete an account","tags":["erp"]},"get":{"operationId":"getAccountByAccountId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The account ID","in":"path","name":"accountId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve an account","tags":["erp"]},"patch":{"operationId":"updateAccountByAccountId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The account ID","in":"path","name":"accountId","required":true,"type":"string"},{"description":"The account","in":"body","name":"account","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update an account","tags":["erp"]}},"/accounts/{accountId}/formulas/{formulaId}/instances":{"get":{"operationId":"getAccountsFormulasInstances","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The account ID","format":"int64","in":"path","name":"accountId","required":true,"type":"integer"},{"description":"The formula ID","format":"int64","in":"path","name":"formulaId","required":true,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/FormulaInstance"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"List formula instances for an account by formula ID","tags":["accounts"]}},"/accounts/{id}":{"delete":{"operationId":"deleteAccountById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the account to delete in the Marketing Automation system.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete an account associated with a given ID from your Marketing Automation system. Specifying an account associated with a given ID that does not exist will result in an error message.","tags":["marketing"]},"get":{"operationId":"getAccountById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the account to retrieve from the Marketing Automation system.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve an account associated with a given ID in the Marketing Automation. Specifying an account with an associated ID that does not exist will result in a error message.","tags":["marketing"]},"patch":{"operationId":"updateAccountById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the account to update in the Marketing Automation system.","in":"path","name":"id","required":true,"type":"string"},{"description":"The account object, with those fields that are to be updated.","in":"body","name":"account","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update an account associated with a given ID in the Marketing Automation system. The update API uses the PATCH HTTP verb, so only those fields provided in the account object will be updated, and those fields not provided will be left alone.","tags":["marketing"]}},"/accounts/{id}/elements/{keyOrId}/transformations":{"delete":{"operationId":"deleteAccountsElementsTransformations","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the account","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The element key or ID","in":"path","name":"keyOrId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Delete the default transformation for all elements of a certain type for this account.","tags":["accounts"]},"get":{"operationId":"getAccountsElementsTransformations","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the account","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The element key or ID","in":"path","name":"keyOrId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/TransformationLibrary"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve the default transformation for all elements of a certain type for this account.","tags":["accounts"]}},"/accounts/{id}/elements/{keyOrId}/transformations/{objectName}":{"delete":{"operationId":"deleteAccountsElementsTransformationByObjectName","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the account","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The element key or ID","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The object name","in":"path","name":"objectName","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Delete the default transformation for an object for all elements of a certain type for this account.","tags":["accounts"]},"get":{"operationId":"getAccountsElementsTransformationByObjectName","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the account","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The element key or ID","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Transformation"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve the default transformation for an object for all elements of a certain type for this account.","tags":["accounts"]},"post":{"operationId":"createAccountElementTransformationByObjectName","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the account","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The element key or ID","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The transformation","in":"body","name":"transformation","required":true,"schema":{"$ref":"#/definitions/Transformation"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Transformation"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Create a default transformation for an object for all elements of a certain type for this account.","tags":["accounts"]},"put":{"operationId":"replaceAccountsElementsTransformationByObjectName","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the account","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The element key or ID","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The transformation","in":"body","name":"transformation","required":true,"schema":{"$ref":"#/definitions/Transformation"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Transformation"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Update the default transformation for an object for all elements of a certain type for this account.","tags":["accounts"]}},"/accounts/{id}/instances":{"get":{"operationId":"getAccountsInstances2","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the account","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"},{"description":"The page size. Defaults to 200 if not provided. Maximum of 200","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/ElementInstance"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Finds all instances for the specified account","tags":["accounts"]}},"/accounts/{id}/objects/definitions":{"delete":{"operationId":"deleteAccountsObjectsDefinitions2","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the account","format":"int64","in":"path","name":"id","required":true,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Delete all object definitions within a specific account. If no object definitions exist then this will result in an error response.","tags":["accounts"]},"get":{"operationId":"getAccountsObjectsDefinitions2","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the account","format":"int64","in":"path","name":"id","required":true,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Dictionary"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve all of the object definitions within a specific account. If no object definitions exist, then this will result in an error response.","tags":["accounts"]},"post":{"operationId":"createAccountObjectDefinition2","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the account","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The object definitions to create","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Dictionary"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Dictionary"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Create multiple object definitions for a specific account. The definitions allow you to define what an object looks like within an account.","tags":["accounts"]}},"/accounts/{id}/objects/{objectName}/definitions":{"delete":{"operationId":"deleteAccountsObjectsObjectNameDefinitions2","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the account","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Delete an object definition associated with an objectName for a specific account. Specifying an object name that does not have an object definition will result in an error response.","tags":["accounts"]},"get":{"operationId":"getAccountsObjectsObjectNameDefinitions2","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the account","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Definition"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve a specific object definition associated with an objectName within a specific account. Specifying an object definition associated with a given objectName that does not exist will result in an error response.","tags":["accounts"]},"post":{"operationId":"createAccountObjectObjectNameDefinition2","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the account","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The object definition","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Definition"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Definition"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Create a new object definition associated with an objectName within a specific account. The definitions allow you to define what an object looks like within an account.","tags":["accounts"]},"put":{"operationId":"replaceAccountsObjectsObjectNameDefinitions2","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the account","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The object definition","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Definition"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Definition"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Update a specific object's definition associated with an objectName within a specific account. Specifying an object definition associated with a given objectName that does not exist will result in an error response.","tags":["accounts"]}},"/accounts/{id}/users":{"get":{"operationId":"getAccountsUsers","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the account","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The CEQL search expression or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for users created on or after 'Jan 15, 2014', the search expression will be where=createdDate >= '2014-01-15'. When this parameter is omitted, all accounts are returned in a paginated fashion.","in":"query","name":"where","required":false,"type":"string"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"},{"description":"The page size. Defaults to 200 if not provided. Maximum of 200","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"Whether to return inactive users in the response. Deleted users will not be returned even if this is set to true. The default is false","in":"query","name":"includeInactive","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/User"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Find users within an account associated by an ID. Specifying a user within an account associated with a given ID that does not exist will result in an error response.","tags":["accounts"]},"post":{"operationId":"createAccountUser","deprecated":true,"description":"This API has been deprecated please refer to the 'OAuth and User Mgmt' APIs","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the account under which the user should be created","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The user to create

The required fields are:


Upon success, the created object will be returned.","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/User"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/User"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Create a user within an account associated by an ID.","tags":["accounts"]}},"/accounts/{id}/users/{userId}":{"get":{"operationId":"getAccountsUserByUserId","deprecated":true,"description":"This API has been deprecated please refer to the 'OAuth and User Mgmt' APIs","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the account","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The email address or numeric ID of the user (emailOrId)","in":"path","name":"userId","required":true,"type":"string"},{"description":"The user's password. If the password is correct, the user secret of this user will also be returned in the response body.","in":"header","name":"Elements-User-Password","required":false,"type":"string"},{"description":"Whether to consider inactive users in the request. Deleted users will not be returned even if this is set to true. The default is false","in":"query","name":"includeInactive","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/User"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve an account user by name or ID within an account associated by an ID. Specifying a user associated with a given emailOrID or account associated with a given ID that does not exist will result in an error response.","tags":["accounts"]},"patch":{"operationId":"updateAccountsUserByUserId","deprecated":true,"description":"This API has been deprecated please refer to the 'OAuth and User Mgmt' APIs","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the account","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The ID of the user","format":"int64","in":"path","name":"userId","required":true,"type":"integer"},{"description":"The updated user information","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/User"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/User"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Update an account user by ID within an account associated by an ID. WARNING: If updating the 'active' field to false, all of the scheduled jobs for the user will be deleted.","tags":["accounts"]},"put":{"operationId":"replaceAccountsUserByUserId","deprecated":true,"description":"This API has been deprecated please refer to the 'OAuth and User Mgmt' APIs","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the account","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The ID of the user","format":"int64","in":"path","name":"userId","required":true,"type":"integer"},{"description":"The updated user information","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/User-PUT"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/User"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Replace the data for an account user by ID within an account associated by an ID. WARNING: If updating the 'active' field to false, all of the scheduled jobs for the user will be deleted.","tags":["accounts"]},"delete":{"operationId":"deleteAccountsUserByUserId","deprecated":true,"description":"This API has been deprecated please refer to the 'OAuth and User Mgmt' APIs","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the account","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The ID of the user","format":"int64","in":"path","name":"userId","required":true,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"bad request - often due to a missing request parameter"},"401":{"description":"unauthorized - an invalid element token, user secret and/or org secret provided"},"403":{"description":"forbidden - access to the resource by the provider is forbidden"},"404":{"description":"not found - the requested resource is not found"},"405":{"description":"method not allowed - incorrect http verb used, e.g., get used when post expected"},"406":{"description":"not acceptable - the response content type does not match the 'accept' header value"},"409":{"description":"conflict - if a resource being created already exists"},"415":{"description":"unsupported media type - the server cannot handle the requested content-type"},"500":{"description":"server error - something went wrong on the cloud elements server"}},"summary":"Delete an account user by ID within an account associated by an ID. WARNING: this action will irreversibly delete all jobs, and formula and element instances associated with the user.","tags":["accounts"]}},"/activities":{"get":{"operationId":"getActivities","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for activities createdDate after 'Jan 15, 2015', the search expression will be where=createdDate>'2015-01-15T00:00:00.000Z'. When this parameter is omitted, all activities are returned in a paginated fashion.","in":"query","name":"where","required":false,"type":"string"},{"description":"The page size for pagination, which defaults to 200 if not supplied","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/Activity"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Find the activities in the Marketing Automation system, using the given, optional CEQL search expression. The search expression in CEQL is the WHERE clause in a typical SQL query, but without the WHERE keyword. For example, to search for all activities whose type contains the word 'email', the search expression parameter will be where=type like '%email%'. If a search expression is not provided, then the first 200 records will be returned. If there are no matches to search expression empty results are returned.","tags":["marketing"]}},"/agents":{"get":{"operationId":"getAgents","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for attachments with file name ScreenShot.jpeg the search expression will be where=fileName>='ScreenShot.jpeg'. When this parameter is omitted, all attachments are returned in a paginated fashion.","in":"query","name":"where","required":false,"type":"string"},{"description":"Specify if deleted attachments should be included in the search.","in":"query","name":"includeDeleted","required":false,"type":"boolean"},{"description":"The number of results to return per page","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Gets a list of user whom the incidents are assigned to.","tags":["helpdesk"]}},"/agents/{id}":{"get":{"operationId":"getAgentById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the agent","in":"path","name":"id","required":true,"type":"string"},{"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for attachments with file name ScreenShot.jpeg the search expression will be where=fileName>='ScreenShot.jpeg'. When this parameter is omitted, all attachments are returned in a paginated fashion.","in":"query","name":"where","required":false,"type":"string"},{"description":"Specify if deleted attachments should be included in the search.","in":"query","name":"includeDeleted","required":false,"type":"boolean"},{"description":"The number of results to return per page","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Gets a user whom the incidents are assigned to.","tags":["helpdesk"]}},"/attachments":{"get":{"operationId":"getAttachments","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for attachments with file name ScreenShot.jpeg the search expression will be where=fileName>='ScreenShot.jpeg'. When this parameter is omitted, all attachments are returned in a paginated fashion.","in":"query","name":"where","required":false,"type":"string"},{"description":"Specify if deleted attachments should be included in the search.","in":"query","name":"includeDeleted","required":false,"type":"boolean"},{"description":"The number of results to return per page","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Search for attachments in the help desk system, using the provided CEQL search expression. The search expression in CEQL is the WHERE clause in a typical SQL query, but without the WHERE keyword. For example, to search for all attachments whose fileName contains the word 'ultraround', the search expression parameter will be where=fileName='%ultraround%'. Performing a search without these parameters will not return any results.

If a value of true is specified for the includeDeleted flag, then any soft-deleted records will also be considered in the searched records.","tags":["helpdesk"]},"post":{"operationId":"createAttachment","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The file to be uploaded","in":"formData","name":"file","type":"file"},{"description":"The name of the file (e.g. myFile.txt)","in":"query","name":"fileName","required":true,"type":"string"},{"description":"Reference token for the attachment","in":"query","name":"referenceToken","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Uploads a attachments to your endpoint helpdesk service.The attachment upload flows through Cloud Elements.","tags":["helpdesk"]}},"/attachments/{id}":{"delete":{"operationId":"deleteAttachmentById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the attachment","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete an attachment with a given ID from the help desk system. Specifying an attachment associated with a given ID that does not exist will result in an error message.","tags":["helpdesk"]},"get":{"operationId":"getAttachmentById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The attachment id.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieves a specific attachment associated with an ID from your helpdesk service.The attachment is directly streamed from the helpdesk provider through Cloud Elements, and is not buffered to disk. Specifying a attachment associated with an ID that does not exist results in an error response.","tags":["helpdesk"]}},"/audit-logs":{"get":{"operationId":"getAuditLogs","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The start date for your search formatted as _yyyy-MM-dd_, for example `2018-01-24`. You can also specify a start time by formatting your search like _yyyy-MM-dd_THH:mm:ss.SSSZ_, for example `2018-01-24T15:56:44.000Z`.","in":"query","name":"from","required":false,"type":"string"},{"description":"The end date for your search formatted as _yyyy-MM-dd_, for example `2018-01-31`. You can also specify a start time by formatting your search like _yyyy-MM-dd_THH:mm:ss.SSSZ_, for example `2018-01-31T15:56:44.000Z`.","in":"query","name":"to","required":false,"type":"string"},{"description":"The unique id of the user that you want to filter. Use `GET /users` to find user ids.","in":"query","name":"userId","required":false,"type":"string"},{"description":"The unique id of the account that you want to filter.","in":"query","name":"accountId","required":false,"type":"string"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"},{"description":"The page size. Defaults to 200 if not provided. Maximum of 200.","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/audit-logs"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve a list of logged API requests that identify the request, the user who made the request, the time that they made the request, and more.","tags":["audit-logs"]}},"/audit-logs/authentication":{"get":{"operationId":"getAuditLogsAuthentication","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The start date for your search formatted as _yyyy-MM-dd_, for example `2018-01-24`. You can also specify a start time by formatting your search like _yyyy-MM-dd_THH:mm:ss.SSSZ_, for example `2018-01-24T15:56:44.000Z`.","in":"query","name":"from","required":false,"type":"string"},{"description":"The end date for your search formatted as _yyyy-MM-dd_, for example `2018-01-31`. You can also specify a start time by formatting your search like _yyyy-MM-dd_THH:mm:ss.SSSZ_, for example `2018-01-31T15:56:44.000Z`.","in":"query","name":"to","required":false,"type":"string"},{"description":"The unique id of the user that you want to filter. Use `GET /users` to find user ids.","in":"query","name":"userId","required":false,"type":"string"},{"description":"The unique id of the account that you want to filter.","in":"query","name":"accountId","required":false,"type":"string"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"},{"description":"The page size. Defaults to 200 if not provided. Maximum of 200.","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/audit-logs"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve a list of logged authentication API requests.","tags":["audit-logs"]}},"/audit-logs/common-resources":{"get":{"operationId":"getAuditLogsCommonResources","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The start date for your search formatted as _yyyy-MM-dd_, for example `2018-01-24`. You can also specify a start time by formatting your search like _yyyy-MM-dd_THH:mm:ss.SSSZ_, for example `2018-01-24T15:56:44.000Z`.","in":"query","name":"from","required":false,"type":"string"},{"description":"The end date for your search formatted as _yyyy-MM-dd_, for example `2018-01-31`. You can also specify a start time by formatting your search like _yyyy-MM-dd_THH:mm:ss.SSSZ_, for example `2018-01-31T15:56:44.000Z`.","in":"query","name":"to","required":false,"type":"string"},{"description":"The unique id of the user that you want to filter. Use `GET /users` to find user ids.","in":"query","name":"userId","required":false,"type":"string"},{"description":"The unique id of the account that you want to filter. ","in":"query","name":"accountId","required":false,"type":"string"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"},{"description":"The page size. Defaults to 200 if not provided. Maximum of 200.","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/audit-logs"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve a list of logged common resource and transformations API requests.","tags":["audit-logs"]}},"/audit-logs/common-resources/{commonResourceName}":{"get":{"operationId":"getAuditLogsCommonResourceByCommonResourceName","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The unique name of the common resource you want to retrieve.","in":"path","name":"commonResourceName","required":true,"type":"string"},{"description":"The start date for your search formatted as _yyyy-MM-dd_, for example `2018-01-24`. You can also specify a start time by formatting your search like _yyyy-MM-dd_THH:mm:ss.SSSZ_, for example `2018-01-24T15:56:44.000Z`.","in":"query","name":"from","required":false,"type":"string"},{"description":"The end date for your search formatted as _yyyy-MM-dd_, for example `2018-01-31`. You can also specify a start time by formatting your search like _yyyy-MM-dd_THH:mm:ss.SSSZ_, for example `2018-01-31T15:56:44.000Z`.","in":"query","name":"to","required":false,"type":"string"},{"description":"The unique id of the user that you want to filter. Use `GET /users` to find user ids.","in":"query","name":"userId","required":false,"type":"string"},{"description":"The unique id of the account that you want to filter.","in":"query","name":"accountId","required":false,"type":"string"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"},{"description":"The page size. Defaults to 200 if not provided. Maximum of 200.","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/audit-logs"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve a list of logged common resource and transformations API requests by the name of the common resource.","tags":["audit-logs"]}},"/audit-logs/element-instances":{"get":{"operationId":"getAuditLogsElementInstances","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The start date for your search formatted as _yyyy-MM-dd_, for example `2018-01-24`. You can also specify a start time by formatting your search like _yyyy-MM-dd_THH:mm:ss.SSSZ_, for example `2018-01-24T15:56:44.000Z`.","in":"query","name":"from","required":false,"type":"string"},{"description":"The end date for your search formatted as _yyyy-MM-dd_, for example `2018-01-31`. You can also specify a start time by formatting your search like _yyyy-MM-dd_THH:mm:ss.SSSZ_, for example `2018-01-31T15:56:44.000Z`.","in":"query","name":"to","required":false,"type":"string"},{"description":"The unique id of the user that you want to filter. Use `GET /users` to find user ids.","in":"query","name":"userId","required":false,"type":"string"},{"description":"The unique id of the account that you want to filter.","in":"query","name":"accountId","required":false,"type":"string"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"},{"description":"The page size. Defaults to 200 if not provided. Maximum of 200.","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/audit-logs"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve a list of logged element instance API requests.","tags":["audit-logs"]}},"/audit-logs/element-instances/{elementInstanceId}":{"get":{"operationId":"getAuditLogsElementInstanceByElementInstanceId","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The unique id of the element instance that you want to retrieve.","in":"path","name":"elementInstanceId","required":true,"type":"string"},{"description":"The start date for your search formatted as _yyyy-MM-dd_, for example `2018-01-24`. You can also specify a start time by formatting your search like _yyyy-MM-dd_THH:mm:ss.SSSZ_, for example `2018-01-24T15:56:44.000Z`.","in":"query","name":"from","required":false,"type":"string"},{"description":"The end date for your search formatted as _yyyy-MM-dd_, for example `2018-01-31`. You can also specify a start time by formatting your search like _yyyy-MM-dd_THH:mm:ss.SSSZ_, for example `2018-01-31T15:56:44.000Z`.","in":"query","name":"to","required":false,"type":"string"},{"description":"The unique id of the user that you want to filter. Use `GET /users` to find user ids.","in":"query","name":"userId","required":false,"type":"string"},{"description":"The unique id of the account that you want to filter.","in":"query","name":"accountId","required":false,"type":"string"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"},{"description":"The page size. Defaults to 200 if not provided. Maximum of 200.","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/audit-logs"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve a list of logged element instance API requests by element instance ID.","tags":["audit-logs"]}},"/audit-logs/elements":{"get":{"operationId":"getAuditLogsElements","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The start date for your search formatted as _yyyy-MM-dd_, for example `2018-01-24`. You can also specify a start time by formatting your search like _yyyy-MM-dd_THH:mm:ss.SSSZ_, for example `2018-01-24T15:56:44.000Z`.","in":"query","name":"from","required":false,"type":"string"},{"description":"The end date for your search formatted as _yyyy-MM-dd_, for example `2018-01-31`. You can also specify a start time by formatting your search like _yyyy-MM-dd_THH:mm:ss.SSSZ_, for example `2018-01-31T15:56:44.000Z`.","in":"query","name":"to","required":false,"type":"string"},{"description":"The unique id of the user that you want to filter. Use `GET /users` to find user ids.","in":"query","name":"userId","required":false,"type":"string"},{"description":"The unique id of the account that you want to filter. ","in":"query","name":"accountId","required":false,"type":"string"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"},{"description":"The page size. Defaults to 200 if not provided. Maximum of 200.","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/audit-logs"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve a list of logged element API requests. Requests include element creation and element extension requests.","tags":["audit-logs"]}},"/audit-logs/elements/{elementId}":{"get":{"operationId":"getAuditLogsElementByElementId","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The unique id of the element you want to retrieve.","in":"path","name":"elementId","required":true,"type":"string"},{"description":"The start date for your search formatted as _yyyy-MM-dd_, for example `2018-01-24`. You can also specify a start time by formatting your search like _yyyy-MM-dd_THH:mm:ss.SSSZ_, for example `2018-01-24T15:56:44.000Z`.","in":"query","name":"from","required":false,"type":"string"},{"description":"The end date for your search formatted as _yyyy-MM-dd_, for example `2018-01-31`. You can also specify a start time by formatting your search like _yyyy-MM-dd_THH:mm:ss.SSSZ_, for example `2018-01-31T15:56:44.000Z`.","in":"query","name":"to","required":false,"type":"string"},{"description":"The unique id of the user that you want to filter. Use `GET /users` to find user ids.","in":"query","name":"userId","required":false,"type":"string"},{"description":"The unique id of the account that you want to filter.","in":"query","name":"accountId","required":false,"type":"string"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"},{"description":"The page size. Defaults to 200 if not provided. Maximum of 200.","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/audit-logs"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve a list of logged element API requests by element ID.","tags":["audit-logs"]}},"/audit-logs/formula-instances":{"get":{"operationId":"getAuditLogsFormulaInstances","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The start date for your search formatted as _yyyy-MM-dd_, for example `2018-01-24`. You can also specify a start time by formatting your search like _yyyy-MM-dd_THH:mm:ss.SSSZ_, for example `2018-01-24T15:56:44.000Z`.","in":"query","name":"from","required":false,"type":"string"},{"description":"The end date for your search formatted as _yyyy-MM-dd_, for example `2018-01-31`. You can also specify a start time by formatting your search like _yyyy-MM-dd_THH:mm:ss.SSSZ_, for example `2018-01-31T15:56:44.000Z`.","in":"query","name":"to","required":false,"type":"string"},{"description":"The unique id of the user that you want to filter. Use `GET /users` to find user ids.","in":"query","name":"userId","required":false,"type":"string"},{"description":"The unique id of the account that you want to filter. ","in":"query","name":"accountId","required":false,"type":"string"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"},{"description":"The page size. Defaults to 200 if not provided. Maximum of 200.","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/audit-logs"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve a list of logged formula instance API requests.","tags":["audit-logs"]}},"/audit-logs/formulas":{"get":{"operationId":"getAuditLogsFormulas","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The start date for your search formatted as _yyyy-MM-dd_, for example `2018-01-24`. You can also specify a start time by formatting your search like _yyyy-MM-dd_THH:mm:ss.SSSZ_, for example `2018-01-24T15:56:44.000Z`.","in":"query","name":"from","required":false,"type":"string"},{"description":"The end date for your search formatted as _yyyy-MM-dd_, for example `2018-01-31`. You can also specify a start time by formatting your search like _yyyy-MM-dd_THH:mm:ss.SSSZ_, for example `2018-01-31T15:56:44.000Z`.","in":"query","name":"to","required":false,"type":"string"},{"description":"The unique id of the user that you want to filter. Use `GET /users` to find user ids.","in":"query","name":"userId","required":false,"type":"string"},{"description":"The unique id of the account that you want to filter.","in":"query","name":"accountId","required":false,"type":"string"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"},{"description":"The page size. Defaults to 200 if not provided. Maximum of 200.","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/audit-logs"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve a list of logged formula template API requests.","tags":["audit-logs"]}},"/audit-logs/formulas/{entityId}":{"get":{"operationId":"getAuditLogsFormulaByEntityId","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The unique entity id of the user that you want to retrieve.","in":"path","name":"entityId","required":true,"type":"string"},{"description":"The start date for your search formatted as _yyyy-MM-dd_, for example `2018-01-24`. You can also specify a start time by formatting your search like _yyyy-MM-dd_THH:mm:ss.SSSZ_, for example `2018-01-24T15:56:44.000Z`.","in":"query","name":"from","required":false,"type":"string"},{"description":"The end date for your search formatted as _yyyy-MM-dd_, for example `2018-01-31`. You can also specify a start time by formatting your search like _yyyy-MM-dd_THH:mm:ss.SSSZ_, for example `2018-01-31T15:56:44.000Z`.","in":"query","name":"to","required":false,"type":"string"},{"description":"The unique id of the user that you want to filter. Use `GET /users` to find user ids.","in":"query","name":"userId","required":false,"type":"string"},{"description":"The unique id of the account that you want to filter.","in":"query","name":"accountId","required":false,"type":"string"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"},{"description":"The page size. Defaults to 200 if not provided. Maximum of 200.","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/audit-logs"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve a list of logged formula template API requests by the Entity ID associated with the object affected. Entity IDs include step ids, trigger ids, and configuration ids.","tags":["audit-logs"]}},"/authentication/passwords":{"post":{"operationId":"createAuthenticationPassword","deprecated":true,"description":"This API has been deprecated please refer to the 'OAuth and User Mgmt' APIs","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The new password.","in":"body","name":"passwordReset","required":true,"schema":{"$ref":"#/definitions/PasswordReset-POST"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/AuthenticatedUser-GET"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Reset the user's password.","tags":["users"]}},"/bulk/lists":{"post":{"operationId":"createBulkList","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Create a new bulk list in the Marketing Automation system with the desired fields and upload a CSV file to populate your new list.","tags":["marketing"]}},"/bulk/query":{"get":{"operationId":"getBulkQuery","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The CEQL query. When this parameter is omitted, all objects of the given type are returned via the bulk job. Endpoint limiters may still apply.","in":"query","name":"q","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/Object"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"beta Execute a bulk query synchronously.","tags":["marketing"]},"post":{"operationId":"createBulkQuery","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The Url to send the notification to when the Job is completed","in":"header","name":"Elements-Async-Callback-Url","required":false,"type":"string"},{"description":"The CEQL query. When this parameter is omitted, all objects of the given type are returned via the bulk job. Endpoint limiters may still apply.","in":"query","name":"q","required":false,"type":"string"},{"description":"The last time this query was run. This is optional. You can also have this parameter in the query and leave this blank - optional eg. '2014-10-06T13:22:17-08:00'","in":"query","name":"lastRunDate","required":false,"type":"string"},{"description":"The created/updated date of the object to filter on - optional eg. '2014-10-06T13:22:17-08:00'","in":"query","name":"from","required":false,"type":"string"},{"description":"The created/updated date of the object to filter on - optional eg. '2014-10-06T13:22:17-08:00'","in":"query","name":"to","required":false,"type":"string"},{"description":"If this id is supplied the previous job will be continued from where it left off and continue to get all records to the time the new job was started. If this value is passed in - the query parameter is ignored","in":"query","name":"continueFromJobId","required":false,"type":"number"},{"description":"The format of the file: csv or json. The default is csv.","enum":["csv","json"],"in":"query","name":"fileFormat","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/BulkQuery"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"beta Create an asynchronous bulk query job.","tags":["marketing"]}},"/bulk/{bulkId}/errors":{"get":{"operationId":"getBulkErrors","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The bulk job ID","in":"path","name":"bulkId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"type":"string"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve the errors for a bulk job","tags":["erp"]}},"/bulk/{bulkId}/status":{"get":{"operationId":"getBulkStatus","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The bulk job ID","in":"path","name":"bulkId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve the status for a bulk job","tags":["erp"]}},"/bulk/{bulkId}/{objectName}":{"get":{"operationId":"getBulkByObjectName","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The bulk job ID","in":"path","name":"bulkId","required":true,"type":"string"},{"description":"The object name","in":"path","name":"objectName","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"type":"file"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve the results for an asynchronous bulk query","tags":["erp"]}},"/bulk/{id}/errors":{"get":{"operationId":"getBulkErrors","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the bulk job to retrieve its errors.","in":"path","name":"id","required":true,"type":"string"},{"description":"The page size for pagination, which defaults to 200 if not supplied","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"type":"string"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"beta Retrieve the errors of a bulk job.","tags":["marketing"]}},"/bulk/{id}/status":{"get":{"operationId":"getBulkStatus","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the bulk job to retrieve its status.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/BulkStatus"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"beta Retrieve the status of a bulk job.","tags":["marketing"]}},"/bulk/{id}/{objectName}":{"get":{"operationId":"getBulkByObjectName","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the bulk job","in":"path","name":"id","required":true,"type":"string"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"type":"file"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"beta Retrieve the results of an asynchronous bulk query.","tags":["marketing"]}},"/bulk/{objectName}":{"post":{"operationId":"createBulkByObjectName","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The name of the object for which data needs to be uploaded.","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The name of the field, which will be used as the ID field for determine inserts v/s updates during the bulk load process.","in":"query","name":"identifierFieldName","required":false,"type":"string"},{"description":"The list of objects to bulk upload.","in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/List"}},{"description":"The file of objects to bulk load.","in":"formData","name":"file","type":"file"}],"produces":["application/json","multipart/form-data"],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"beta Upload a file of objects to be bulk uploaded to the provider.","tags":["marketing"]}},"/campaigns":{"get":{"operationId":"getCampaigns","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for campaigns last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all campaigns are returned in a paginated fashion.","in":"query","name":"where","required":false,"type":"string"},{"description":"The page size for pagination, which defaults to 200 if not supplied","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"Specify if deleted campaigns should be included in the search.","in":"query","name":"includeDeleted","required":false,"type":"boolean"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/Campaign"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Find campaigns in the Marketing Automation system, using the provided CEQL search expression. The search expression in CEQL is the WHERE clause in a typical SQL query, but without the WHERE keyword. For example, to search for all campaigns whose name contains the word 'data', the search expression parameter will be where=name like '%data%'. If a search expression is not provided, then the first 200 records will be returned.

If a value of true is specified for the includeDeleted flag, then any soft-deleted records will also be considered in the searched records.","tags":["marketing"]},"post":{"operationId":"createCampaign","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The campaign object to be created.
With the exception of the 'id' field, the required fields indicated in the 'Campaign' model are those required to create a new campaign.","in":"body","name":"campaign","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Create a new campaign in the Marketing Automation service. Campaign creation will flow through Cloud Elements to your Marketing Automation service. With the exception of the 'id' field, the required fields indicated in the 'Campaign' model are those required to create a new campaign.","tags":["marketing"]}},"/campaigns/{campaignId}/contacts":{"get":{"operationId":"getCampaignsContacts","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the campaign, for which the contacts need to be searched and retrieved.","in":"path","name":"campaignId","required":true,"type":"string"},{"description":"An optional CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for contacts by the contact ID, the search expression will be where=ContactId='003i0000014sR6D'. When this parameter is omitted, all contacts in the given campaign are returned.","in":"query","name":"where","required":false,"type":"string"},{"description":"The page size for pagination, which defaults to 200 if not supplied","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/Contact"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Find contacts in the campaign associated with a given ID, using the given, optional CEQL search expression. If the campaign does not exist, an error response will be returned. If no search expression is provided, then all the contacts in the campaign will be returned. If no contacts are found in the given campaign or none are found matching the given search expression, then an empty array will be returned.","tags":["marketing"]},"patch":{"operationId":"updateCampaignsContacts","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the campaign, to which contacts need to be added.","in":"path","name":"campaignId","required":true,"type":"string"},{"description":"The contact object which needs to be added to the campaign. This object has a different set of attributes than the Contact model object.","in":"body","name":"campaignContacts","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/CampaignContact"}}}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Add contacts to the campaign associated with the given campaign ID. This API assumes that the contacts already exist in the Marketing Automation system, and simply links the contacts with the campaign.","tags":["marketing"]}},"/campaigns/{campaignId}/contacts/{contactId}":{"delete":{"operationId":"deleteCampaignsContactByContactId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the campaign, from which a contact need to be deleted.","in":"path","name":"campaignId","required":true,"type":"string"},{"description":"The ID of the contact, which needs to be deleted from the campaign.","in":"path","name":"contactId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete the association between the contact associated with the given contact ID from the campaign associated with the given campaign ID. This API only unlinks the contact from the campaign, and does not delete the contact from the Marketing Automation system.","tags":["marketing"]}},"/campaigns/{campaignId}/leads":{"get":{"operationId":"getCampaignsLeads","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the campaign, for which the leads need to be searched and retrieved.","in":"path","name":"campaignId","required":true,"type":"string"},{"description":"An optional CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for leads by the lead ID, the search expression will be where=LeadId='003i0000014sR6D'. When this parameter is omitted, all leads in the given campaign are returned.","in":"query","name":"where","required":false,"type":"string"},{"description":"The page size for pagination, which defaults to 200 if not supplied","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/Lead"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Find leads in the campaign associated with a given ID, using the given, optional CEQL search expression. If the campaign does not exist, an error response will be returned. If no search expression is provided, then all the leads in the campaign will be returned. If no leads are found in the given campaign or none are found matching the given search expression, then an empty array will be returned.","tags":["marketing"]},"put":{"operationId":"replaceCampaignsLeads","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the campaign, to which leads need to be added.","in":"path","name":"campaignId","required":true,"type":"string"},{"description":"The lead object which needs to be added to the campaign. This object has a different set of attributes than the Lead model object.","in":"body","name":"campaignLeads","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Add leads to the campaign associated with the given campaign ID. This API assumes that the leads already exist in the Marketing Automation system, and simply links the leads with the campaign.","tags":["marketing"]}},"/campaigns/{campaignId}/leads/{leadId}":{"delete":{"operationId":"deleteCampaignsLeadByLeadId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the campaign, from which a lead need to be deleted.","in":"path","name":"campaignId","required":true,"type":"string"},{"description":"The ID of the lead, which needs to be deleted from the campaign.","in":"path","name":"leadId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete the association between the contact associated with the given contact ID from the campaign associated with the given campaign ID. This API only unlinks the contact from the campaign, and does not delete the contact from the Marketing Automation system.","tags":["marketing"]}},"/campaigns/{id}":{"delete":{"operationId":"deleteCampaignById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the campaign to delete in the Marketing Automation system.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete a campaign associated with a given ID from your Marketing Automation system. Specifying a campaign associated with a given ID that does not exist will result in an error message.","tags":["marketing"]},"get":{"operationId":"getCampaignById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the campaign to retrieve from the Marketing Automation system.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve a campaign associated with a given ID from your Marketing Automation system. Specifying a campaign associated with a given ID that does not exist will result in an error response.","tags":["marketing"]},"patch":{"operationId":"updateCampaignById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the campaign to update in the Marketing Automation system.","in":"path","name":"id","required":true,"type":"string"},{"description":"The campaign object, with those fields that are to be updated.","in":"body","name":"campaign","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update the campaign associated with the given ID in the Marketing Automation system. The update API uses the PATCH HTTP verb, so only those fields provided in the campaign object will be updated, and those fields not provided will be left alone.","tags":["marketing"]}},"/classes":{"get":{"operationId":"getClasses","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for accounts last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all accounts are returned ","in":"query","name":"where","required":false,"type":"string"},{"description":"The page size for pagination, which defaults to 200 if not supplied","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/Class"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Find Classes in the Finance System, using the provided CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for classes last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all Classes are returned.","tags":["finance"]}},"/classes/{id}":{"get":{"operationId":"getClasseById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The Id of the class or category to retrieve from the finance system.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve a defined Class or Category associated with a given ID from the Finance system. Specifying a class or category with an associated ID that does not exist will result in an error response.","tags":["finance"]}},"/contacts":{"get":{"operationId":"getContacts","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for contacts last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all contacts are returned in a paginated fashion.","in":"query","name":"where","required":false,"type":"string"},{"description":"The page size for pagination, which defaults to 200 if not supplied","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"Specify if deleted contacts should be included in the search.","in":"query","name":"includeDeleted","required":false,"type":"boolean"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/Contact"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Find contacts in the Marketing Automation system, using the provided CEQL search expression. The search expression in CEQL is the WHERE clause in a typical SQL query, but without the WHERE keyword. For example, to search for all contacts whose name contains the word 'data', the search expression parameter will be where=name like '%data%'. If a search expression is not provided, then the first 200 records will be returned.

If a value of true is specified for the includeDeleted flag, then any soft-deleted records will also be considered in the searched records.","tags":["marketing"]},"post":{"operationId":"createContact","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The contact object to be created.
With the exception of the 'id' field, the required fields indicated in the 'Contact' model are those required to create a new contact.","in":"body","name":"contact","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Create a new contact in the Marketing Automation service. Contact creation will flow through Cloud Elements to your Marketing Automation service. With the exception of the 'id' field, the required fields indicated in the 'Contact' model are those required to create a new contact.","tags":["marketing"]}},"/contacts/{contactId}":{"delete":{"operationId":"deleteContactByContactId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The contact ID","in":"path","name":"contactId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete a contact","tags":["erp"]},"get":{"operationId":"getContactByContactId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The contact ID","in":"path","name":"contactId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve a contact","tags":["erp"]},"patch":{"operationId":"updateContactByContactId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The contact ID","in":"path","name":"contactId","required":true,"type":"string"},{"description":"The contact","in":"body","name":"contact","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update a contact","tags":["erp"]}},"/contacts/{contactId}/activities":{"get":{"operationId":"getContactsActivities","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for contacts last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all contacts are returned in a paginated fashion.","in":"query","name":"where","required":false,"type":"string"},{"description":"The page size for pagination, which defaults to 200 if not supplied","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"A contact ID to find activities from.","in":"path","name":"contactId","required":true,"type":"string"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/Activity"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Find the activities of a contact associated with given ID, using the given, optional CEQL search expression. If the contact does not exist, an error response will be returned. If no search expression is provided, then all the activities in the contact will be returned. If no activities are found in the given contact or none are found matching the given search expression, then an empty array will be returned.","tags":["marketing"]}},"/contacts/{contactId}/activities/{activityId}":{"get":{"operationId":"getContactsActivityByActivityId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the contact where the activity exists","in":"path","name":"contactId","required":true,"type":"string"},{"description":"The ID of the activity to retrieve from the Marketing Automation system.","in":"path","name":"activityId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve an activity associated with given ContactId and ActivityId from your Marketing Automation system. Specifying a Contact associated with a given ContactID or Activity with a given ActivityId that does not exist will result in an error response.","tags":["marketing"]}},"/contacts/{id}":{"delete":{"operationId":"deleteContactById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the contact to delete in the Marketing Automation system.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete a contact associated with a given ID from your Marketing Automation system. Specifying a contact associated with a given ID that does not exist will result in an error message.","tags":["marketing"]},"get":{"operationId":"getContactById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the contact to retrieve from the Marketing Automation system.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve a contact associated with a given ID from your Marketing Automation system. Specifying a contact associated with a given ID that does not exist will result in an error response.","tags":["marketing"]},"patch":{"operationId":"updateContactById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the contact to update in the Marketing Automation system.","in":"path","name":"id","required":true,"type":"string"},{"description":"The contact object, with those fields that are to be updated.","in":"body","name":"contact","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update the contact associated with the given ID in the Marketing Automation system. The update API uses the PATCH HTTP verb, so only those fields provided in the contact object will be updated, and those fields not provided will be left alone.","tags":["marketing"]}},"/credit-terms":{"get":{"operationId":"getCreditTerms","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for accounts last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all accounts are returned ","in":"query","name":"where","required":false,"type":"string"},{"description":"The page size for pagination, which defaults to 200 if not supplied","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/CreditTerm"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Find Credit Terms in the Finance System, using the provided CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for credit terms last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all Credit Terms are returned.","tags":["finance"]}},"/credit-terms/{creditTermId}":{"get":{"operationId":"getCreditTermByCreditTermId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The credit term ID","in":"path","name":"creditTermId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve a credit term","tags":["erp"]}},"/credit-terms/{id}":{"get":{"operationId":"getCreditTermById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The Id of the credit term to retrieve from the finance system.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve a defined Credit Term Lookup associated with a given ID from the Finance system. Specifying a credit term with an associated ID that does not exist will result in an error response.","tags":["finance"]}},"/customers":{"get":{"operationId":"getCustomers","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for customers last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all customers are returned in a paginated fashion.","in":"query","name":"where","required":false,"type":"string"},{"description":"Specify if deleted customers should be included in the search.","in":"query","name":"includeDeleted","required":false,"type":"boolean"},{"description":"The number of results to fetch in a given page. When this parameter is omitted, a maximum of 200 results are returned.","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/Customer"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Find customers in the eCommerce system, using the provided CEQL search expression. The search expression in CEQL is the WHERE clause in a typical SQL query, but without the WHERE keyword. For example, to search for all customers whose name contains the word 'data', the search expression parameter will be where=name like '%data%'. If a search expression is not provided, then the first 200 records will be returned.

If a value of true is specified for the includeDeleted flag, then any soft-deleted records will also be considered in the searched records.","tags":["ecommerce"]},"post":{"operationId":"createCustomer","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The Customer object to be created.
With the exception of the 'id' field, the required fields indicated in the 'Customer' model are those required to create a new customer.","in":"body","name":"customer","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Create a new customer in the eCommerce system. Customer creation will flow through Cloud Elements to your eCommerce service. With the exception of the 'id' field, the required fields indicated in the 'Customer' model are those required to create a new customer.","tags":["ecommerce"]}},"/customers/identity-providers":{"post":{"operationId":"createCustomerIdentityProvider","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The identity provider data","in":"body","name":"identityProvider","required":true,"schema":{"$ref":"#/definitions/IdentityProvider-POST"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/IdentityProvider-GET"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Create a new identity provider within a customer. NOTE: This API requires the 'customer-admin' privilege.","tags":["customers"]},"get":{"operationId":"getCustomersIdentityProviders","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"type":"array","items":{"$ref":"#/definitions/IdentityProvider-GET"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Get all of the identity providers within a customer. NOTE: This API requires the 'customer-admin' privilege.","tags":["customers"]}},"/customers/identity-providers/{id}":{"get":{"operationId":"getCustomersIdentityProviderById","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the identity provider record","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/IdentityProvider-GET"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Get a specific identity provider within a customer. NOTE: This API requires the 'customer-admin' privilege.","tags":["customers"]},"delete":{"operationId":"deleteCustomersIdentityProviderById","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the identity provider record","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Delete an identity provider within a customer. NOTE: This API requires the 'customer-admin' privilege.","tags":["customers"]}},"/customers/me":{"get":{"operationId":"getCustomersMe","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Customer-GET"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Get details of the current user's customer.","tags":["customers"]}},"/customers/organizations":{"get":{"operationId":"getCustomersOrganizations","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"},{"description":"The page size. Defaults to 200 if not provided. Maximum of 200","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The CEQL search expression or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for organizations with a specific externalId, the search expression will be where=externalId='my-ext-id'. When this parameter is omitted, all organizations for the customer are returned in a paginated fashion","in":"query","name":"where","required":false,"type":"string"},{"description":"Whether to include inactive (deleted) organizations in the results. The default is false","in":"query","name":"includeInactive","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"type":"array","items":{"$ref":"#/definitions/Organization-GET"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Get all of the organizations for the current user's customer. NOTE: This API requires the 'customer-admin' privilege.","tags":["customers"]}},"/customers/organizations/{id}":{"get":{"operationId":"getCustomersOrganizationById","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the organization","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"Whether to consider inactive (deleted) organizations in the request. The default is false","in":"query","name":"includeInactive","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Organization-GET"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Get a specific organization within the current user's customer. NOTE: This API requires the 'customer-admin' privilege.","tags":["customers"]},"delete":{"operationId":"deleteCustomersOrganizationById","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the organization","format":"int64","in":"path","name":"id","required":true,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Delete a specific organization within the current user's customer. NOTE: This API requires the 'customer-admin' privilege.","tags":["customers"]}},"/customers/signup":{"post":{"operationId":"createCustomerSignup","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The customer sign up data","in":"body","name":"customerSignup","required":true,"schema":{"$ref":"#/definitions/CustomerSignup-POST"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/CustomerSignup-GET"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Create a new user within a customer. The organization and account will also be created, if existing IDs are not provided. NOTE: This API requires the 'customer-admin' privilege.","tags":["customers"]}},"/customers/{customerId}":{"delete":{"operationId":"deleteCustomerByCustomerId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The customer ID","in":"path","name":"customerId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete a customer","tags":["erp"]},"get":{"operationId":"getCustomerByCustomerId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The customer ID","in":"path","name":"customerId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve a customer","tags":["erp"]},"patch":{"operationId":"updateCustomerByCustomerId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The customer ID","in":"path","name":"customerId","required":true,"type":"string"},{"description":"The customer","in":"body","name":"customer","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update a customer","tags":["erp"]}},"/customers/{id}":{"delete":{"operationId":"deleteCustomerById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the customer to delete from the eCommerce system.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete a customer associated with a given ID from your eCommerce system.\nSpecifying a customer associated with a given ID that does not exist will result in an error message.","tags":["ecommerce"]},"get":{"operationId":"getCustomerById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the customer to retrieve from the eCommerce system.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve a customer associated with a given ID from the eCommerce system.Specifying a customer with a specified ID that does not exist will result in an error response.","tags":["ecommerce"]},"patch":{"operationId":"updateCustomerById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the customer to update in the eCommerce system.","in":"path","name":"id","required":true,"type":"string"},{"description":"The customer object, with those fields that are to be updated.","in":"body","name":"customer","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update a customer associated with a given ID in the eCommerce system. The update API uses the PATCH HTTP verb, so only those fields provided in the customer object will be updated, and those fields not provided will be left aloneUpdating a customer with a specified ID that does not exist will result in an error response.","tags":["ecommerce"]}},"/customers/{id}/abandoned-checkouts":{"get":{"operationId":"getCustomersAbandonedCheckouts","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the customer to get abandoned checkouts from in the eCommerce system.","in":"path","name":"id","required":true,"type":"string"},{"description":"The number of results to fetch in a given page. When this parameter is omitted, a maximum of 200 results are returned.","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Find abandoned checkouts in the customer associated with a given ID. If the customer does not exist, an error response will be returned. If no abandoned checkouts are found in the given customer then an empty array will be returned.","tags":["ecommerce"]}},"/customers/{id}/orders":{"get":{"operationId":"getCustomersOrders","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the customer to get orders form in the eCommerce system.","in":"path","name":"id","required":true,"type":"string"},{"description":"The number of results to fetch in a given page. When this parameter is omitted, a maximum of 200 results are returned.","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/Order"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Find orders in the customer associated with a given ID. If the customer does not exist, an error response will be returned. If no orders are found in the given customer then an empty array will be returned.","tags":["ecommerce"]}},"/elements":{"post":{"operationId":"createElement","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element","in":"body","name":"element","required":true,"schema":{"$ref":"#/definitions/CreateElement"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Element"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Create a new element.","tags":["elementsbuilder"]}},"/elements/keys":{"get":{"operationId":"getElementsKeys","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":false,"type":"string"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"},{"description":"The page size. Defaults to 200 if not provided. Maximum of 200","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"type":"string"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve all available elements keys.","tags":["elements"]}},"/elements/{id}/docs":{"get":{"operationId":"getElementsDocs","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":false,"type":"string"},{"description":"The ID of the element","in":"path","name":"id","required":true,"type":"string"},{"description":"The id of the operation for which swagger docs is returned","in":"query","name":"operationId","required":false,"type":"string"},{"description":"The element swagger version to get the corresponding element swagger, Passing in \"-1\" gives latest element swagger","in":"query","name":"version","required":false,"default":"-1","type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/swaggerDocs"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Swagger 2.0 schema for the element.","tags":["elements"]}},"/elements/{id}/metadata":{"get":{"operationId":"getElementsMetadata","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":false,"type":"string"},{"description":"The element ID","format":"int64","in":"path","name":"id","required":true,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/ElementMetadata"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve the metadata for the specified element.","tags":["elements"]}},"/elements/{id}/objects/{objectName}/docs":{"get":{"operationId":"getElementsObjectsObjectNameDocs","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the element","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The element swagger version to get the corresponding element swagger, Passing in \"-1\" gives latest element swagger","in":"query","name":"version","required":false,"default":"-1","type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/swaggerDocs"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Get swagger docs for an object.","tags":["elements"]}},"/elements/{id}/objects/{objectName}/metadata":{"get":{"operationId":"getElementsObjectsObjectNameMetadata","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the element","in":"path","name":"id","required":true,"type":"string"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The 'method' param helps to retrieve specific metadata based on the API method type and request or response. If one wants to retrieve metadata for POST API request body the method param should hold a value like method=POST_request and for response body method=POST_response","in":"query","name":"method","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/objectsMetadata"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Get a list of all the fields for an object.","tags":["elements"]}},"/elements/{id}/operations":{"get":{"operationId":"getElementsOperations","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":false,"type":"string"},{"description":"The element ID","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The element swagger version to get the corresponding element swagger, Passing in \"-1\" gives latest element swagger","in":"query","name":"version","required":false,"default":"-1","type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/Operations"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve the swagger docs operations for the specified element.","tags":["elements"]}},"/elements/{id}/operations/{operationId}/docs":{"get":{"operationId":"getElementsOperationsDocs","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the element","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The id of the operation for which swagger docs is returned","format":"int64","in":"path","name":"operationId","required":true,"type":"string"},{"description":"The element swagger version to get the corresponding element swagger, Passing in \"-1\" gives latest element swagger","in":"query","name":"version","required":false,"default":"-1","type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/swaggerDocs"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve an operation specific swagger documentation for an element","tags":["elements"]}},"/elements/{id}/versions":{"get":{"operationId":"getElementsVersions","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":false,"type":"string"},{"description":"The ID of the element","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/swaggerDocVersionsObject"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Swagger 2.0 schema for the element.","tags":["elements"]}},"/elements/{keyOrId}":{"delete":{"operationId":"deleteElementByKeyOrId","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key (i.e. 'dropbox', 'sfdc', etc.) or ID","in":"path","name":"keyOrId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Delete an element.","tags":["elementsbuilder"]},"put":{"operationId":"replaceElementByKeyOrId","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key (i.e. 'dropbox', 'sfdc', etc.) or ID","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The element","in":"body","name":"element","required":true,"schema":{"$ref":"#/definitions/CreateElement"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Element"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Update an element associated with an element key.","tags":["elementsbuilder"]}},"/elements/{keyOrId}/active":{"delete":{"operationId":"deleteElementsActive","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key (i.e. 'dropbox', 'sfdc', etc.) or ID","in":"path","name":"keyOrId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"De-activate an element, which will remove it from your elements catalog.","tags":["elementsbuilder"]},"put":{"operationId":"replaceElementsActive","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key (i.e. 'dropbox', 'sfdc', etc.) or ID","in":"path","name":"keyOrId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Activate an element to publish it in your elements catalog.","tags":["elementsbuilder"]}},"/elements/{keyOrId}/configuration":{"get":{"operationId":"getElementsConfiguration","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":false,"type":"string"},{"description":"The element key (i.e. 'dropbox', 'sfdc', etc.) or ID","in":"path","name":"keyOrId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/ElementConfigs"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve a specific element configuration associated with an element key. Specifying an element associated with an element key that does not exist results in an error response.","tags":["elementsbuilder"]},"post":{"operationId":"createElementConfiguration","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key (i.e. 'dropbox', 'sfdc', etc.) or ID","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The configuration to create","in":"body","name":"configuration","required":true,"schema":{"$ref":"#/definitions/Configuration"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Configuration"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Create a new configuration value for an element","tags":["elementsbuilder"]}},"/elements/{keyOrId}/configuration/{configurationKey}":{"delete":{"operationId":"deleteElementsConfigurationByConfigurationKey","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key (i.e. 'dropbox', 'sfdc', etc.) or ID","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The configuration key","in":"path","name":"configurationKey","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Delete a configuration value for an element","tags":["elementsbuilder"]},"put":{"operationId":"replaceElementsConfigurationByConfigurationKey","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key (i.e. 'dropbox', 'sfdc', etc.) or ID","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The configuration key","in":"path","name":"configurationKey","required":true,"type":"string"},{"description":"The configuration object","in":"body","name":"configuration","required":true,"schema":{"$ref":"#/definitions/Configuration"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Configuration"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Update an existing configuration value for an element","tags":["elementsbuilder"]}},"/elements/{keyOrId}/events":{"get":{"operationId":"getElementsEvents","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>, Element <element secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key (i.e. 'dropbox', 'sfdc', etc.) or ID","in":"path","name":"keyOrId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/EventPayloadBody"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Allows retrieving the enabled event notifications for one or more objects","tags":["elements"]},"put":{"operationId":"replaceElementsEvents","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>, Element <element secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key (i.e. 'dropbox', 'sfdc', etc.) or ID","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The event payload","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/EventPayloadBody"}}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Allows enabling event notifications for one or more objects","tags":["elements"]},"delete":{"operationId":"deleteElementsEvents","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>, Element <element secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key (i.e. 'dropbox', 'sfdc', etc.) or ID","in":"path","name":"keyOrId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Allows disabling all events notifications for a connection (Instance)","tags":["elements"]}},"/elements/{keyOrId}/export":{"get":{"operationId":"getElementsExport","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":false,"type":"string"},{"description":"The element key (i.e. 'dropbox', 'sfdc', etc.) or ID","in":"path","name":"keyOrId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"type":"file"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Downloads a specific element JSON data in a file associated with an element key. Specifying an element associated with an element key that does not exist results in an error response.","tags":["elementsbuilder"]}},"/elements/{keyOrId}/hooks":{"get":{"operationId":"getElementsHooks","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key","in":"path","name":"keyOrId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/Hook"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve the hooks that exists for a element","tags":["elementsbuilder"]},"post":{"operationId":"createElementHook","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The element Hook","in":"body","name":"model","required":true,"schema":{"$ref":"#/definitions/Hook"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Hook"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Create a new hook for a element","tags":["elementsbuilder"]}},"/elements/{keyOrId}/hooks/{hookId}":{"get":{"operationId":"getElementsHookByHookId","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The Hook ID","in":"path","name":"hookId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Hook"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Get an existing hook for an custom element","tags":["elementsbuilder"]},"delete":{"operationId":"deleteElementsHookByHookId","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The hook ID","in":"path","name":"hookId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Delete one of the hooks for a element","tags":["elementsbuilder"]},"put":{"operationId":"replaceElementsHookByHookId","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The hook ID","in":"path","name":"hookId","required":true,"type":"string"},{"description":"The hook","in":"body","name":"parameter","required":true,"schema":{"$ref":"#/definitions/Hook"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Hook"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Update an existing Hook for an element","tags":["elementsbuilder"]}},"/elements/{keyOrId}/instances":{"get":{"operationId":"getElementsInstances","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key (i.e. 'dropbox', 'sfdc', etc.) or ID","in":"path","name":"keyOrId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/ElementInstance"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve all element instances from a specified path. The instances go through Cloud Elements to your console. Specifying an instance that does not exist results in an error response.","tags":["elements"]},"post":{"operationId":"createElementInstance","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key (i.e. 'dropbox', 'sfdc', etc.) or ID","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The element instance to create","in":"body","name":"elementInstance","required":true,"schema":{"$ref":"#/definitions/ElementInstance"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/ElementInstancePost"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Create a new element instance in your console. Instance creation will flow through Cloud Elements to your console.","tags":["elements"]}},"/elements/{keyOrId}/instances/{id}":{"delete":{"operationId":"deleteElementsInstanceById","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key (i.e. 'dropbox', 'sfdc', etc.) or ID","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The ID of the element instance","format":"int64","in":"path","name":"id","required":true,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Delete an instance associated with a given ID from your console. Specifying an instance associated with a given ID that does not exist will result in an error message.","tags":["elements"]},"get":{"operationId":"getElementsInstanceById","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key (i.e. 'dropbox', 'sfdc', etc.) or ID","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The ID of the element instance","format":"int64","in":"path","name":"id","required":true,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/ElementInstancePost"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve an element instance associated with a given ID from a specified path. The instance goes through Cloud Elements to your console. Specifying an instance with an associated ID that does not exist results in an error response.","tags":["elements"]},"put":{"operationId":"replaceElementsInstanceById","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key (i.e. 'dropbox', 'sfdc', etc.) or ID","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The ID of the element instance","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The fields of the element instance to update","in":"body","name":"elementInstance","required":true,"schema":{"$ref":"#/definitions/ElementInstance"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/ElementInstancePut"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Update an instance associated with a given ID from your console. Specifying an instance associated with an ID that does not exist will result in an error message.","tags":["elements"]}},"/elements/{keyOrId}/oauth/token":{"get":{"operationId":"getElementsOauthToken","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key (i.e. 'dropbox', 'sfdc', etc.) or ID","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The OAuth API key","in":"query","name":"apiKey","required":true,"type":"string"},{"description":"The OAuth API secret","in":"query","name":"apiSecret","required":true,"type":"string"},{"description":"The OAuth callback URL","in":"query","name":"callbackUrl","required":true,"type":"string"},{"description":"The OAuth scope","in":"query","name":"scope","required":false,"type":"string"},{"description":"The OAuth state","in":"query","name":"state","required":false,"type":"string"},{"description":"Site address can be used for Evernote for the sandbox site address. If left null, the site address will default to Evernote's production address.","in":"query","name":"siteAddress","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/OAuthToken"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve the OAuth 1 request token. Not applicable with OAuth 2 Elements.","tags":["elements"]}},"/elements/{keyOrId}/oauth/url":{"get":{"operationId":"getElementsOauthUrl","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key (i.e. 'dropbox', 'sfdc', etc.) or ID","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The OAuth API key","in":"query","name":"apiKey","required":true,"type":"string"},{"description":"The OAuth API secret (note: For HubSpot, this is the Portal ID.)","in":"query","name":"apiSecret","required":true,"type":"string"},{"description":"The OAuth callback URL","in":"query","name":"callbackUrl","required":true,"type":"string"},{"description":"The OAuth scope","in":"query","name":"scope","required":false,"type":"string"},{"description":"The OAuth state","in":"query","name":"state","required":false,"type":"string"},{"description":"The callback URL is proxy or not, default value is false","in":"query","name":"callbackProxy","required":false,"type":"boolean"},{"description":"The OAuth1 Request Token","in":"query","name":"requestToken","required":false,"type":"string"},{"description":"Site address must be used for: Sharepoint (hosted environments); Salesforce.com (if environment is other than the default); Evernote (to specify the sandbox address)","in":"query","name":"siteAddress","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/OAuthRedirect"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve the OAuth 2 redirect URL associated with the specified element. Specifying an element key associated with an element that does not exist results in an error response.","tags":["elements"]},"post":{"operationId":"createElementOauthUrl","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key (i.e. 'dropbox', 'sfdc', etc.) or ID","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The data for generating the OAuth redirect URL","in":"body","name":"oauthInfo","required":true,"schema":{"$ref":"#/definitions/OAuthInfo"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/OAuthRedirect"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve the OAuth 2 redirect URL associated with the specified element. Specifying an element key associated with an element that does not exist results in an error response.","tags":["elements"]}},"/elements/{keyOrId}/objects":{"get":{"operationId":"getElementsObjects","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"Account only query parameter to get account only resources","in":"query","name":"accountOnly","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/Object"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve all of the objects that exist for a custom element","tags":["elementsbuilder"]},"post":{"operationId":"createElementObject","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The Object","in":"body","name":"object","required":true,"schema":{"$ref":"#/definitions/Object"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Create a new object for a element","tags":["elementsbuilder"]}},"/elements/{keyOrId}/objects/{id}":{"delete":{"operationId":"deleteElementsObjectById","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The Object Id","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Delete a object for a custom element","tags":["elementsbuilder"]},"put":{"operationId":"replaceElementsObjectById","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The Object Id","in":"path","name":"id","required":true,"type":"string"},{"description":"The Object","in":"body","name":"object","required":true,"schema":{"$ref":"#/definitions/Object"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Update an existing object for an element","tags":["elementsbuilder"]},"get":{"operationId":"getElementsObjectById","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The Object Id","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Get an existing object for an element","tags":["elementsbuilder"]}},"/elements/{keyOrId}/objects/{id}/fields":{"post":{"operationId":"createElementObjectField","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The Object Id","in":"path","name":"id","required":true,"type":"string"},{"description":"The Field","in":"body","name":"field","required":true,"schema":{"$ref":"#/definitions/Field"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Field"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Create a Field for an element Object","tags":["elementsbuilder"]},"get":{"operationId":"getElementsObjectsFields","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The Object Id","in":"path","name":"id","required":true,"type":"string"},{"description":"Account only query parameter to get account only resources","in":"query","name":"accountOnly","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/Field"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve all of the fields that exist for a element object","tags":["elementsbuilder"]}},"/elements/{keyOrId}/objects/{id}/fields/{fieldId}":{"delete":{"operationId":"deleteElementsObjectsFieldByFieldId","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The Object Id","in":"path","name":"id","required":true,"type":"string"},{"description":"The Field Id","in":"path","name":"fieldId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Delete a field for an element object","tags":["elementsbuilder"]},"put":{"operationId":"replaceElementsObjectsFieldByFieldId","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The Object Id","in":"path","name":"id","required":true,"type":"string"},{"description":"The Field Id","in":"path","name":"fieldId","required":true,"type":"string"},{"description":"The Field","in":"body","name":"object","required":true,"schema":{"$ref":"#/definitions/Field"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Field"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Update an existing field for an element object","tags":["elementsbuilder"]},"get":{"operationId":"getElementsObjectsFieldByFieldId","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The Object Id","in":"path","name":"id","required":true,"type":"string"},{"description":"The Field Id","in":"path","name":"fieldId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Field"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Get an existing field for an element object","tags":["elementsbuilder"]}},"/elements/{keyOrId}/parameters":{"get":{"operationId":"getElementsParameters","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key","in":"path","name":"keyOrId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/DefaultParameter"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve all of the default parameters for an element","tags":["elementsbuilder"]},"post":{"operationId":"createElementParameter","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The default parameter","in":"body","name":"parameter","required":true,"schema":{"$ref":"#/definitions/DefaultParameter"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/DefaultParameter"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Create a new default parameter for an element","tags":["elementsbuilder"]}},"/elements/{keyOrId}/parameters/{id}":{"delete":{"operationId":"deleteElementsParameterById","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The ID of the parameter","in":"path","name":"id","required":true,"type":"string"},{"description":"The default parameter","in":"body","name":"parameter","required":true,"schema":{"$ref":"#/definitions/DefaultParameter"}}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Delete a default parameter for an element","tags":["elementsbuilder"]},"put":{"operationId":"replaceElementsParameterById","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The ID of the parameter","in":"path","name":"id","required":true,"type":"string"},{"description":"The default parameter","in":"body","name":"parameter","required":true,"schema":{"$ref":"#/definitions/DefaultParameter"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/DefaultParameter"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Update a default parameter for an element","tags":["elementsbuilder"]}},"/elements/{keyOrId}/resources":{"get":{"operationId":"getElementsResources","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for resources whose method is 'GET', the search expression will be where=method='GET'. Only supported parameters are method, path and type.","in":"query","name":"where","required":false,"type":"string"},{"description":"The element key or Id","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"Account only query parameter to get account only resources","in":"query","name":"accountOnly","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/Resource"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve all of the resources that exist for a custom element","tags":["elementsbuilder"]},"post":{"operationId":"createElementResource","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The resource","in":"body","name":"resource","required":true,"schema":{"$ref":"#/definitions/Resource"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Resource"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Create a new resource for a custom element","tags":["elementsbuilder"]}},"/elements/{keyOrId}/resources/{id}":{"delete":{"operationId":"deleteElementsResourceById","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The resource ID","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Delete a resource for a custom element","tags":["elementsbuilder"]},"put":{"operationId":"replaceElementsResourceById","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The resource ID","in":"path","name":"id","required":true,"type":"string"},{"description":"The resource","in":"body","name":"resource","required":true,"schema":{"$ref":"#/definitions/Resource"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Resource"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Update an existing resource for an element","tags":["elementsbuilder"]},"get":{"operationId":"getElementsResourceById","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The resource ID","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Resource"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Get an existing resource for an element","tags":["elementsbuilder"]}},"/elements/{keyOrId}/resources/{id}/hooks":{"get":{"operationId":"getElementsResourcesHooks","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The resource ID","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/Hook"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve the hooks that exists for a custom element's resource","tags":["elementsbuilder"]},"post":{"operationId":"createElementResourceHook","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The resource ID","in":"path","name":"id","required":true,"type":"string"},{"description":"The resource Hook","in":"body","name":"model","required":true,"schema":{"$ref":"#/definitions/Hook"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Hook"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Create a new hook for a custom element's resource","tags":["elementsbuilder"]}},"/elements/{keyOrId}/resources/{id}/hooks/{hookId}":{"get":{"operationId":"getElementsResourcesHookByHookId","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The resource ID","in":"path","name":"id","required":true,"type":"string"},{"description":"The Hook ID","in":"path","name":"hookId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Hook"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Get an existing hook for an custom element's resource","tags":["elementsbuilder"]},"delete":{"operationId":"deleteElementsResourcesHookByHookId","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The resource ID","in":"path","name":"id","required":true,"type":"string"},{"description":"The hook ID","in":"path","name":"hookId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Delete one of the hooks for a custom element's resource","tags":["elementsbuilder"]},"put":{"operationId":"replaceElementsResourcesHookByHookId","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The resource ID","in":"path","name":"id","required":true,"type":"string"},{"description":"The hook ID","in":"path","name":"hookId","required":true,"type":"string"},{"description":"The hook","in":"body","name":"parameter","required":true,"schema":{"$ref":"#/definitions/Hook"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Hook"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Update an existing Hook for an element's resource","tags":["elementsbuilder"]}},"/elements/{keyOrId}/resources/{id}/models":{"delete":{"operationId":"deleteElementsResourcesModels","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The resource ID","format":"int64","in":"path","name":"id","required":true,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Delete the model for this custom element's resource","tags":["elementsbuilder"]},"get":{"operationId":"getElementsResourcesModels","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The resource ID","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Model"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve the models that exists for a custom element's resource","tags":["elementsbuilder"]},"post":{"operationId":"createElementResourceModel","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The resource ID","in":"path","name":"id","required":true,"type":"string"},{"description":"The model","in":"body","name":"model","required":true,"schema":{"$ref":"#/definitions/Model"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Model"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Create a new model for a custom element's resource","tags":["elementsbuilder"]}},"/elements/{keyOrId}/resources/{id}/parameters":{"get":{"operationId":"getElementsResourcesParameters","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The resource ID","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/Parameter"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve all of the parameters for a resource","tags":["elementsbuilder"]},"post":{"operationId":"createElementResourceParameter","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The resource ID","in":"path","name":"id","required":true,"type":"string"},{"description":"The parameter","in":"body","name":"parameter","required":true,"schema":{"$ref":"#/definitions/Parameter"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Parameter"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Create a new parameter for a custom element's resource","tags":["elementsbuilder"]}},"/elements/{keyOrId}/resources/{id}/parameters/{parameterId}":{"delete":{"operationId":"deleteElementsResourcesParameterByParameterId","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The resource ID","in":"path","name":"id","required":true,"type":"string"},{"description":"The parameter ID","in":"path","name":"parameterId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Delete one of the parameters for a custom element's resource","tags":["elementsbuilder"]},"put":{"operationId":"replaceElementsResourcesParameterByParameterId","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The resource ID","in":"path","name":"id","required":true,"type":"string"},{"description":"The parameter ID","in":"path","name":"parameterId","required":true,"type":"string"},{"description":"The parameter","in":"body","name":"parameter","required":true,"schema":{"$ref":"#/definitions/Parameter"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Parameter"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Update an existing parameters for an element's resource","tags":["elementsbuilder"]}},"/employees":{"get":{"operationId":"getEmployees","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for accounts last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all employees are returned ","in":"query","name":"where","required":false,"type":"string"},{"description":"The page size for pagination, which defaults to 200 if not supplied","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/Employee"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Find Employees in the Finance System, using the provided CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for employees last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all Employees are returned.","tags":["humancapital"]},"post":{"operationId":"createEmployee","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The Employee object to be created.
With the exception of the 'id' field, the required fields indicated in the 'Employee' model are those required to create a new employee","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Create an Employee in the Finance system. Employee creation will flow through Cloud Elements to the Finance Service.","tags":["humancapital"]}},"/employees/{employeeId}":{"delete":{"operationId":"deleteEmployeeByEmployeeId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The employee ID","in":"path","name":"employeeId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete an employee","tags":["erp"]},"get":{"operationId":"getEmployeeByEmployeeId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The employee ID","in":"path","name":"employeeId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve an employee","tags":["erp"]},"patch":{"operationId":"updateEmployeeByEmployeeId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The employee ID","in":"path","name":"employeeId","required":true,"type":"string"},{"description":"The employee","in":"body","name":"employee","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update an employee","tags":["erp"]}},"/employees/{id}":{"delete":{"operationId":"deleteEmployeeById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the employee to delete in the Finance system.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete an Employee associated with a given ID from the Finance system. This marks the employee as inactive. Specifying an Employee associated with a given ID that does not exist will result in an error message.","tags":["humancapital"]},"get":{"operationId":"getEmployeeById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The Id of the employee to retrieve from the finance system.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve an Employee associated with a given ID from the Finance system. Specifying an Employee with an associated ID that does not exist will result in an error response.","tags":["humancapital"]},"patch":{"operationId":"updateEmployeeById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the employee to update in the Finance system.","in":"path","name":"id","required":true,"type":"string"},{"description":"The employee object, with those fields that are to be updated.","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update an Employee given a set of partial attributes associated with a given ID in the Finance system. The update API uses the PATCH HTTP verb, so only those fields provided in the Employee object will be updated, and those fields not provided will be left alone. Updating an Employee with a specified ID that does not exist will result in an error response.","tags":["humancapital"]}},"/envelopes":{"get":{"operationId":"getEnvelopes","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The CEQL search expression. The 'from_date' search field is required. Other valid search fields include 'to_date', 'from_to_status', 'status', 'ac_status', 'envelopeId', 'custom_field' or 'transactionId'","in":"query","name":"where","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/envelopesListObject"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Search for envelopes whose status has changed","tags":["esignature"]},"post":{"operationId":"createEnvelope","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The envelope","in":"formData","name":"envelope","required":true,"type":"The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Create an envelope","tags":["esignature"],"consumes":["multipart/form-data"]}},"/envelopes/{envelopeId}":{"get":{"operationId":"getEnvelopeByEnvelopeId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The envelope ID","in":"string","name":"envelopeId","required":true,"type":"path"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve an envelope","tags":["esignature"]},"patch":{"operationId":"updateEnvelopeByEnvelopeId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The envelope ID","in":"string","name":"envelopeId","required":true,"type":"path"},{"description":"The envelope","in":"body","name":"envelope","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/envelopes"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update an envelope","tags":["esignature"]}},"/envelopes/{envelopeId}/documents":{"get":{"operationId":"getEnvelopesDocuments","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The envelope ID","in":"string","name":"envelopeId","required":true,"type":"path"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/documents"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve all documents for an envelope","tags":["esignature"]},"put":{"operationId":"replaceEnvelopesDocuments","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The envelope ID","in":"string","name":"envelopeId","required":true,"type":"path"},{"description":"The document","in":"formData","name":"document","required":true,"type":"The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"},{"description":"The file to upload","in":"formData","name":"file","type":"file","required":true}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/documents"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Add a document to an envelope","tags":["esignature"],"consumes":["multipart/form-data"]}},"/envelopes/{envelopeId}/documents/certificates":{"get":{"operationId":"getEnvelopesDocumentsCertificates","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The envelope ID","in":"string","name":"envelopeId","required":true,"type":"path"},{"description":"The document ID","in":"string","name":"documentId","required":true,"type":"path"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"type":"file"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Download the document's certificate for an envelope as a PDF","tags":["esignature"]}},"/envelopes/{envelopeId}/documents/{documentId}":{"get":{"operationId":"getEnvelopesDocumentByDocumentId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The envelope ID","in":"string","name":"envelopeId","required":true,"type":"path"},{"description":"The document ID","in":"string","name":"documentId","required":true,"type":"path"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"type":"file"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Download a document from an envelope","tags":["esignature"]}},"/envelopes/{envelopeId}/recipients":{"post":{"operationId":"createEnvelopeRecipient","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The envelope ID","in":"string","name":"envelopeId","required":true,"type":"path"},{"description":"The recipient","in":"body","name":"recipient","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Add a recipient to an envelope. More recipient types can be found here","tags":["esignature"]}},"/envelopes/{envelopeId}/recipients/{recipientId}/tabs":{"post":{"operationId":"createEnvelopeRecipientTab","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The envelope ID","in":"string","name":"envelopeId","required":true,"type":"path"},{"description":"The recipient ID","in":"string","name":"recipientId","required":true,"type":"path"},{"description":"The tab","in":"body","name":"tab","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Create a tab for a recipient. More tab types can be found here","tags":["esignature"]}},"/fields/{type}":{"get":{"operationId":"getFieldByType","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for attachments with file name ScreenShot.jpeg the search expression will be where=type>='Status'. When this parameter is omitted, all attachments are returned in a paginated fashion.","in":"query","name":"where","required":false,"type":"string"},{"description":"The field type to be created, it can be incident-field or user-field.","in":"path","name":"type","required":true,"type":"string"},{"description":"The number of results to return per page","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Search for fields in the help desk system, using the provided CEQL search expression. The search expression in CEQL is the WHERE clause in a typical SQL query, but without the WHERE keyword. For example, to search for all fields whose type contains the word 'status', the search expression parameter will be where=type='status'. Performing a search without these parameters will not return any results.","tags":["helpdesk"]},"post":{"operationId":"createFieldByType","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The field type to be created, it can be incident-field or user-field.","in":"path","name":"type","required":true,"type":"string"},{"description":"The field to create","in":"body","name":"field","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Create a new field in the help desk system. Field creation will flow through Cloud Elements to the help desk service. If a field already exists will return an error message.","tags":["helpdesk"]}},"/fields/{type}/{id}":{"delete":{"operationId":"deleteFieldById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The field type to be created, it can be incident-field or user-field.","in":"path","name":"type","required":true,"type":"string"},{"description":"The field id.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete a field from the help desk system.If the field does not exist will result in an error message.","tags":["helpdesk"]},"get":{"operationId":"getFieldById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The field type to be created, it can be incident-field or user-field.","in":"path","name":"type","required":true,"type":"string"},{"description":"The field id.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve a field from the help desk systemField that does not exist will result in an error response.","tags":["helpdesk"]},"patch":{"operationId":"updateFieldById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The field type to be created, it can be incident-field or user-field.","in":"path","name":"type","required":true,"type":"string"},{"description":"The field id.","in":"path","name":"id","required":true,"type":"string"},{"description":"The field, containing only the fields to update","in":"body","name":"field","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update a field in the help desk system. The update API uses the PATCH HTTP verb, so only those fields provided in the field object will be updated, and those fields not provided will be left alone. Updating field that does not exist will result in an error response.","tags":["helpdesk"]}},"/files":{"delete":{"operationId":"deleteFiles","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The full path to the file (e.g. /myDirectory/myFile.txt)","in":"query","name":"path","required":true,"type":"string"},{"description":"Whether or not the trash should be emptied","in":"query","name":"emptyTrash","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Deletes a file from your cloud service by its specified path.","tags":["documents"]},"get":{"operationId":"getFiles","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The full path to the file (e.g. /myDirectory/myFile.txt)","in":"query","name":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/CloudFile"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieves a single file from your cloud service from a specified path. The file is directly streamed from the cloud storage provider through Cloud Elements, and is not buffered to disk.","tags":["documents"]},"post":{"consumes":["multipart/form-data"],"operationId":"createFile","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The file to be uploaded","in":"formData","name":"file","type":"file"},{"description":"The full path to the file (e.g. /myDirectory/myFile.txt)","in":"query","name":"path","required":true,"type":"string"},{"description":"The size of the file in bytes (required only for SharePoint)","format":"int64","in":"query","name":"size","required":false,"type":"integer"},{"description":"Tags associated with the file","in":"query","items":{"type":"string"},"name":"tags[]","required":false,"type":"array"},{"description":"Description of the file","in":"query","name":"description","required":false,"type":"string"},{"description":"Overwrite the file if the file exists","in":"query","name":"overwrite","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/CloudFile"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Uploads a file to your endpoint cloud service. If the destination path includes directories that do not exist, they will be created.","tags":["documents"]}},"/files/copy":{"post":{"operationId":"createFileCopy","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The full path to the file (e.g. /myDirectory/myFile.txt)","in":"query","name":"path","required":true,"type":"string"},{"description":"A CloudFile object representing the destination file. Path is required and no other fields are supported.","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/CloudFile"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/CloudFile"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Copies a file specified by a file path to another file path, leaving the original intact. If the source file path does not exist an error response is returned. If the destination path includes directories that do not exist, they will be created. Copying a file that already exists results in an error response.","tags":["documents"]}},"/files/links":{"get":{"operationId":"getFilesLinks","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The full path to the file (e.g. /myDirectory/myFile.txt)","in":"query","name":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/CloudLink"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Returns a link that can be used to download the specified file through Cloud Elements. The link can be used to download the file without providing credentials.","tags":["documents"]}},"/files/metadata":{"get":{"operationId":"getFilesMetadata","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The full path to the file (e.g. /myDirectory/myFile.txt)","in":"query","name":"path","required":true,"type":"string"},{"description":"Optional query parameter to return the created and modified date/time in ISO8601 format.","in":"query","name":"isoDates","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/CloudFile"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieves the metadata from a single file on your cloud service from a specified path.","tags":["documents"]},"patch":{"operationId":"updateFilesMetadata","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The full path to the file (e.g. /myDirectory/myFile.txt)","in":"query","name":"path","required":true,"type":"string"},{"description":"A Metadata object with the fields to update. Valid values include path and tags","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Metadata"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/CloudFile"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update a file's metadata (tags and path) associated with a path. For example, if you had a document that was tagged as operations but needed to be tagged as legal, then you would perform a PATCH to update the tag using the tags JSON array field. The PATCH method can update the name or directory of a file as well as move a file by using the path JSON field. You cannot update the size of a file.","tags":["documents"]}},"/files/{id}":{"delete":{"operationId":"deleteFileById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The file ID. For Sharepoint and Dropbox, this is the double URL-encoded path of the file. In this case, the ID must still be URL-encoded on the request, either automatically (e.g. Swagger), or programmatically if the client doesn't take care of it.","in":"path","name":"id","required":true,"type":"string"},{"description":"Whether or not the trash should be emptied","in":"query","name":"emptyTrash","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Deletes a specific file associated with an ID from your cloud service using its specified path.","tags":["documents"]},"get":{"operationId":"getFileById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The file ID. For Sharepoint and Dropbox, this is the double URL-encoded path of the file. In this case, the ID must still be URL-encoded on the request, either automatically (e.g. Swagger), or programmatically if the client doesn't take care of it.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/CloudFile"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieves a specific file associated with an ID from your cloud service from a specified path. The file is directly streamed from the cloud storage provider through Cloud Elements, and is not buffered to disk.","tags":["documents"]}},"/files/{id}/copy":{"post":{"operationId":"createFileCopy2","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The file ID. For Sharepoint and Dropbox, this is the double URL-encoded path of the file. In this case, the ID must still be URL-encoded on the request, either automatically (e.g. Swagger), or programmatically if the client doesn't take care of it.","in":"path","name":"id","required":true,"type":"string"},{"description":"A CloudFile object representing the destination file. Path is required","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/CloudFile"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/CloudFile"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Copies a file associated with an ID from a specified file path to another file path, leaving the original intact. If the source file associated with an ID does not exist an error response is returned. If the destination path includes directories that do not exist they will be created. Copying a file that already exists results in an error response.","tags":["documents"]}},"/files/{id}/links":{"get":{"operationId":"getFilesLinks2","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The file ID. For Sharepoint and Dropbox, this is the double URL-encoded path of the file. In this case, the ID must still be URL-encoded on the request, either automatically (e.g. Swagger), or programmatically if the client doesn't take care of it.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/CloudLink"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Returns a link associated with an ID that can be used to download the specified file through Cloud Elements. The link can be used to download the file without providing credentials.","tags":["documents"]}},"/files/{id}/metadata":{"get":{"operationId":"getFilesMetadata2","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The file ID. For Sharepoint and Dropbox, this is the double URL-encoded path of the file. In this case, the ID must still be URL-encoded on the request, either automatically (e.g. Swagger), or programmatically if the client doesn't take care of it.","in":"path","name":"id","required":true,"type":"string"},{"description":"Optional query parameter to return the created and modified date/time in ISO8601 format.","in":"query","name":"isoDates","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/CloudFile"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieves specific metadata on a file associated with an ID from your cloud service using its specified path.","tags":["documents"]},"patch":{"operationId":"updateFilesMetadata2","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The file ID. For Sharepoint and Dropbox, this is the double URL-encoded path of the file. In this case, the ID must still be URL-encoded on the request, either automatically (e.g. Swagger), or programmatically if the client doesn't take care of it.","in":"path","name":"id","required":true,"type":"string"},{"description":"A Metadata object with the fields to update. Valid values include path and tags","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Metadata"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/CloudFile"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update a file's metadata (tags and path) associated with an ID. For example, if you had a document that was tagged as operations but needed to be tagged as legal, then you would perform a PATCH to update the tag using the tags JSON array field. The PATCH method can update the name or directory of a file as well as move a file by using the path JSON field. You cannot update the size of a file.","tags":["documents"]}},"/folders":{"delete":{"operationId":"deleteFolders","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The full path to the folder (e.g. /myDirectory)","in":"query","name":"path","required":true,"type":"string"},{"description":"Whether or not the trash should be emptied","in":"query","name":"emptyTrash","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Deletes an entire folder from your cloud service by its specified path. The folder specified is deleted from your cloud service.","tags":["documents"]},"post":{"operationId":"createFolder","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"A CloudFile object with the fields to create. Valid values include path","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/CloudFile"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/CloudFile"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Creates a new folder on your cloud service using its specified path. Creation of the new folder goes through Cloud Elements. If the destination path includes directories that do not exist they will be created. Creating a folder that already exists results in an error response.","tags":["documents"]}},"/folders/contents":{"get":{"operationId":"getFoldersContents","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The full path to the folder (e.g. /myDirectory)","in":"query","name":"path","required":true,"type":"string"},{"description":"Whether or not to return the tags for the files in the folder","in":"query","name":"fetchTags","required":false,"type":"boolean"},{"description":"Optional query parameter to return the created and modified date/time in ISO8601 format.","in":"query","name":"isoDates","required":false,"type":"boolean"},{"description":"The page size for pagination, which defaults to 200 if not supplied","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/CloudFile"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Get a list of CloudFiles that are contained in a specified folder on your cloud service specified by a path.","tags":["documents"]}},"/folders/copy":{"post":{"operationId":"createFolderCopy","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The full path to the existing folder (e.g. /myDirectory)","in":"query","name":"path","required":true,"type":"string"},{"description":"A CloudFile object representing the destination folder. Path is required","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/CloudFile"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/CloudFile"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Copies a folder specified by a file path to another file path, leaving the original intact. If the source path does not exist an error response is returned. If the destination path includes directories that do not exist, they will be created.","tags":["documents"]}},"/folders/metadata":{"get":{"operationId":"getFoldersMetadata","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The full path to the folder (e.g. /myDirectory)","in":"query","name":"path","required":true,"type":"string"},{"description":"Optional query parameter to return the created and modified date/time in ISO8601 format.","in":"query","name":"isoDates","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/CloudFile"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieves specific metadata on a folder from your cloud service using its specified path.","tags":["documents"]},"patch":{"operationId":"updateFoldersMetadata","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The full path to the existing folder (e.g. /myDirectory)","in":"query","name":"path","required":true,"type":"string"},{"description":"A Metadata object with the field to update. Valid values include path","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Metadata"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/CloudFile"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update a folder's metadata (path) associated with its path. For example, if you had a folder that was located in the operations directory, but needed to be moved into the legal directory, then you would perform a PATCH using the path JSON field to update the path. The PATCH method can update the name or directory path of a folder also by using the path JSON field. You cannot update the size of a folder.","tags":["documents"]}},"/folders/{id}":{"delete":{"operationId":"deleteFolderById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The folder ID. For Sharepoint and Dropbox, this is the double URL-encoded path of the file. In this case, the ID must still be URL-encoded on the request, either automatically (e.g. Swagger), or programmatically if the client doesn't take care of it.","in":"path","name":"id","required":true,"type":"string"},{"description":"Whether or not the trash should be emptied","in":"query","name":"emptyTrash","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Deletes an entire folder associated with an ID from your cloud service.","tags":["documents"]}},"/folders/{id}/contents":{"get":{"operationId":"getFoldersContents2","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The folder ID. For Sharepoint and Dropbox, this is the double URL-encoded path of the file. In this case, the ID must still be URL-encoded on the request, either automatically (e.g. Swagger), or programmatically if the client doesn't take care of it.","in":"path","name":"id","required":true,"type":"string"},{"description":"Whether or not to return the tags for the files in the folder","in":"query","name":"fetchTags","required":false,"type":"boolean"},{"description":"Optional query parameter to return the created and modified date/time in ISO8601 format.","in":"query","name":"isoDates","required":false,"type":"boolean"},{"description":"The page size for pagination, which defaults to 200 if not supplied","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/CloudFile"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieves a list of CloudFiles that are contained in a specified folder associated with an ID on your cloud service via a specified path.","tags":["documents"]}},"/folders/{id}/copy":{"post":{"operationId":"createFolderCopy2","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The folder ID. For Sharepoint and Dropbox, this is the double URL-encoded path of the file. In this case, the ID must still be URL-encoded on the request, either automatically (e.g. Swagger), or programmatically if the client doesn't take care of it.","in":"path","name":"id","required":true,"type":"string"},{"description":"A CloudFile object representing the destination folder. Path is required","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/CloudFile"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/CloudFile"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Copies a folder associated with an ID specified by a file path to another file path, leaving the original intact. If the source path does not exist an error response is returned. If the destination path includes directories that do not exist, they will be created. Copying a folder that already exists results in an error response.","tags":["documents"]}},"/folders/{id}/metadata":{"get":{"operationId":"getFoldersMetadata2","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The folder ID. For Sharepoint and Dropbox, this is the double URL-encoded path of the file. In this case, the ID must still be URL-encoded on the request, either automatically (e.g. Swagger), or programmatically if the client doesn't take care of it.","in":"path","name":"id","required":true,"type":"string"},{"description":"Optional query parameter to return the created and modified date/time in ISO8601 format.","in":"query","name":"isoDates","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/CloudFile"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieves specific metadata on a folder associated with an ID from your cloud service using its specified path.","tags":["documents"]},"patch":{"operationId":"updateFoldersMetadata2","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The folder ID. For Sharepoint and Dropbox, this is the double URL-encoded path of the file. In this case, the ID must still be URL-encoded on the request, either automatically (e.g. Swagger), or programmatically if the client doesn't take care of it.","in":"path","name":"id","required":true,"type":"string"},{"description":"A Metadata object with the field to update. Valid values include path","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Metadata"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/CloudFile"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update a folder's metadata (path) associated with an ID. For example, if you had the ID of a folder that was located in the operations directory, but needed to be moved into the legal directory, then you would perform a PATCH using the path JSON field to update the path. The PATCH method can update the name or directory of a folder also by using the path JSON field. You cannot update the size of a folder.","tags":["documents"]}},"/formulas":{"get":{"operationId":"getFormulas","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"Whether to include Cloud Elements-created formula templates.","in":"query","name":"includeSystem","required":false,"type":"boolean"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"},{"description":"The page size. Defaults to 200 if not provided. Maximum of 200","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The CEQL search expression supported for id and name with 'IN' operator only. For example, to search for formulae whose id's are 1 or 22, the search expression will be where=id in ('1', '22')","in":"query","name":"where","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/GetFormula"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve a list of all formula templates.","tags":["formulas"]},"post":{"operationId":"createFormula","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The formula template.","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/CreateFormula"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/GetFormula"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Create a new formula template.","tags":["formulas"]}},"/formulas/analytics":{"get":{"operationId":"getFormulasAnalytics","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"Start time in ISO 8601 format, e.g. '2014-04-14T00:00:00-4:00'. An unspecified time zone defaults to UTC. Defaults to one week prior to the current date.","in":"query","name":"from","required":false,"type":"string"},{"description":"End time in ISO 8601 format, e.g. '2014-04-14T00:00:00-4:00'. An unspecified time zone defaults to UTC. Defaults to the current date.","in":"query","name":"to","required":false,"type":"string"},{"description":"Interval to be sent for the data to be returned, it can be year, quarter, month, week, day, hour, minute, second","enum":["year","quarter","month","week","day","hour","minute","second"],"in":"query","name":"interval","required":false,"type":"string"},{"description":"The comma-separated list of account IDs to search. Only applicable for organization admin. Defaults to current user's account only.'","in":"query","name":"accountIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/AnalyticsEntry"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve the number of formula executions within a given date/time range","tags":["formulas"]}},"/formulas/analytics/accounts":{"get":{"operationId":"getFormulasAnalyticsAccounts","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"Start time in ISO 8601 format, e.g. '2014-04-14T00:00:00-4:00'. An unspecified time zone defaults to UTC. Defaults to one week prior to the current date.","in":"query","name":"from","required":false,"type":"string"},{"description":"End time in ISO 8601 format, e.g. '2014-04-14T00:00:00-4:00'. An unspecified time zone defaults to UTC. Defaults to the current date.","in":"query","name":"to","required":false,"type":"string"},{"description":"Interval to be sent for the data to be returned, it can be year, quarter, month, week, day, hour, minute, second","enum":["year","quarter","month","week","day","hour","minute","second"],"in":"query","name":"interval","required":false,"type":"string"},{"description":"The comma-separated list of account IDs to search. Only applicable for organization admins. Defaults to current user's account only.'","in":"query","name":"accountIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/AccountAnalyticsEntry"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve the status analytics of formula step executions within a given date/time range, aggregated by account ID. This API is really only useful for organization admins where more than one account exists.","tags":["formulas"]}},"/formulas/analytics/instances":{"get":{"operationId":"getFormulasAnalyticsInstances","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"Start time in ISO 8601 format, e.g. '2014-04-14T00:00:00-4:00'. An unspecified time zone defaults to UTC. Defaults to one week prior to the current date.","in":"query","name":"from","required":false,"type":"string"},{"description":"End time in ISO 8601 format, e.g. '2014-04-14T00:00:00-4:00'. An unspecified time zone defaults to UTC. Defaults to the current date.","in":"query","name":"to","required":false,"type":"string"},{"description":"Interval to be sent for the data to be returned, it can be year, quarter, month, week, day, hour, minute, second","enum":["year","quarter","month","week","day","hour","minute","second"],"in":"query","name":"interval","required":false,"type":"string"},{"description":"The comma-separated list of account IDs to search. Only applicable for organization admins. Defaults to current user's account only.'","in":"query","name":"accountIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/InstanceAnalyticsEntry"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve the status analytics of formula step executions within a given date/time range, aggregated by formula instance ID.","tags":["formulas"]}},"/formulas/analytics/statuses":{"get":{"operationId":"getFormulasAnalyticsStatuses","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"Start time in ISO 8601 format, e.g. '2014-04-14T00:00:00-4:00'. An unspecified time zone defaults to UTC. Defaults to one week prior to the current date.","in":"query","name":"from","required":false,"type":"string"},{"description":"End time in ISO 8601 format, e.g. '2014-04-14T00:00:00-4:00'. An unspecified time zone defaults to UTC. Defaults to the current date.","in":"query","name":"to","required":false,"type":"string"},{"description":"Interval to be sent for the data to be returned, it can be year, quarter, month, week, day, hour, minute, second","enum":["year","quarter","month","week","day","hour","minute","second"],"in":"query","name":"interval","required":false,"type":"string"},{"description":"The comma-separated list of account IDs to search. Only applicable for organization admin. Defaults to current user's account only.'","in":"query","name":"accountIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/StatusAnalyticsEntry"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve the status analytics of formula executions within a given date/time range","tags":["formulas"]}},"/formulas/analytics/statuses/now":{"get":{"operationId":"getFormulasAnalyticsStatusesNow","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The comma-separated list of account IDs to search. Only applicable for organization admin. Defaults to current user's account only.'","in":"query","name":"accountIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/StatusNowEntry"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve the current status counts of formula executions. If any executions are in a 'retry' status, a list of those execution IDs will be returned, along with the retry attempt that will be executed next.","tags":["formulas"]}},"/formulas/analytics/steps":{"get":{"operationId":"getFormulasAnalyticsSteps","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"Start time in ISO 8601 format, e.g. '2014-04-14T00:00:00-4:00'. An unspecified time zone defaults to UTC. Defaults to one week prior to the current date.","in":"query","name":"from","required":false,"type":"string"},{"description":"End time in ISO 8601 format, e.g. '2014-04-14T00:00:00-4:00'. An unspecified time zone defaults to UTC. Defaults to the current date.","in":"query","name":"to","required":false,"type":"string"},{"description":"Interval to be sent for the data to be returned, it can be year, quarter, month, week, day, hour, minute, second","enum":["year","quarter","month","week","day","hour","minute","second"],"in":"query","name":"interval","required":false,"type":"string"},{"description":"The comma-separated list of account IDs to search. Only applicable for organization admin. Defaults to current user's account only.'","in":"query","name":"accountIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/StepAnalyticsEntry"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve the analytics (execution time, execution delay, etc.) of formula step executions within a given date/time range","tags":["formulas"]}},"/formulas/instances":{"get":{"operationId":"getFormulasInstances","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The id of the an element instance.","format":"int64","in":"query","name":"elementInstanceId","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"},{"description":"The page size. Defaults to 200 if not provided. Maximum of 200","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"Search by instance name or formula name","in":"query","name":"searchText","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/GetAllFormulaInstances"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve all instances of all formula templates.","tags":["formulas"]}},"/formulas/instances/executions/steps/{stepExecutionId}/values":{"get":{"operationId":"getFormulasInstancesExecutionsStepsValues","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the step execution.","format":"int64","in":"path","name":"stepExecutionId","required":true,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/StepExecutionValue"},"type":"array"}},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"404":{"description":"Not found - The requested resource is not found"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve all step execution values for a formula step execution.","tags":["formulas"]}},"/formulas/instances/executions/{executionId}":{"get":{"operationId":"getFormulasInstancesExecutionByExecutionId","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the formula instance execution.","format":"int64","in":"path","name":"executionId","required":true,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/FormulaExecution"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the "Accept" header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve a formula instance executions.","tags":["formulas"]},"patch":{"operationId":"updateFormulasInstancesExecutionByExecutionId","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the formula instance execution.","format":"int64","in":"path","name":"executionId","required":true,"type":"integer"},{"description":"The change in status you want to effect, currently only 'cancel' is supported","in":"body","name":"status","required":true,"schema":{"$ref":"#/definitions/FormulaInstanceStatus"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/FormulaExecution"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the "Accept" header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Cancel a formula instance execution","tags":["formulas"]}},"/formulas/instances/executions/{executionId}/errors":{"get":{"operationId":"getFormulasInstancesExecutionsErrors","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the execution.","format":"int64","in":"path","name":"executionId","required":true,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/StepExecution"},"type":"array"}},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"404":{"description":"Not found - The requested resource is not found"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve all step execution errors for a formula execution.","tags":["formulas"]}},"/formulas/instances/executions/{executionId}/step-values":{"get":{"operationId":"getFormulasInstancesExecutionsStepValues","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the execution.","format":"int64","in":"path","name":"executionId","required":true,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"type":"file"}},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"404":{"description":"Not found - The requested resource is not found"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve all step execution values for a formula execution.","produces":["application/octet-stream"],"tags":["formulas"]}},"/formulas/instances/executions/{executionId}/steps":{"get":{"operationId":"getFormulasInstancesExecutionsSteps","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the execution.","format":"int64","in":"path","name":"executionId","required":true,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"},{"description":"The page size. Defaults to 200 if not provided. Maximum of 200","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/StepExecution"},"type":"array"}},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"404":{"description":"Not found - The requested resource is not found"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve all step executions for a formula execution.","produces":["application/json","application/octet-stream"],"tags":["formulas"]}},"/formulas/instances/{instanceId}":{"get":{"operationId":"getFormulasInstanceByInstanceId","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the formula instance.","format":"int64","in":"path","name":"instanceId","required":true,"type":"integer"},{"description":"Default false. If true response includes deleted instance","in":"query","name":"includeDeleted","type":"boolean","default":"false","required":false}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/GetAllFormulaInstances"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the "Accept" header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve a formula instance.","tags":["formulas"]}},"/formulas/instances/{instanceId}/executions":{"get":{"operationId":"getFormulasInstancesExecutions","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the formula instance.","format":"int64","in":"path","name":"instanceId","required":true,"type":"integer"},{"description":"The event ID, which will return all executions that were triggered by a specific event.","in":"query","name":"eventId","required":false,"type":"string"},{"description":"The object ID, which will return all executions that were triggered by a specific object.","in":"query","name":"objectId","required":false,"type":"string"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"},{"description":"The page size. Defaults to 200 if not provided. Maximum of 200","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/FormulaExecution"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve all executions for a formula instance.","tags":["formulas"]},"post":{"operationId":"createFormulaInstanceExecution","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the formula instance.","format":"int64","in":"path","name":"instanceId","required":true,"type":"integer"},{"description":"The trigger payload. This will look different based on what `type` of formula you're kicking off","in":"body","name":"trigger","schema":{"$ref":"#/definitions/FormulaExecutionBody"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/FormulaExecution"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"404":{"description":"Not found - The requested resource is not found"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Manually kickoff a formula instance from the given JSON trigger payload","tags":["formulas"]}},"/formulas/instances/{instanceId}/executions/errors":{"get":{"operationId":"getFormulasInstancesExecutionsErrors2","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the formula instance.","format":"int64","in":"path","name":"instanceId","required":true,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"},{"description":"The page size. Defaults to 200 if not provided. Maximum of 200","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"Start time in ISO 8601 format, e.g. '2014-04-14T00:00:00-04:00'. An unspecified time zone defaults to UTC. Defaults to 7 days before end date. Only executions completed (failed or success) after this time will be returned.","in":"query","name":"from","required":false,"type":"string"},{"description":"End time in ISO 8601 format, e.g. '2014-04-14T00:00:00-04:00'. An unspecified time zone defaults to UTC. Only executions completed (failed or success) before this time will be returned. Defaults to the current time.","in":"query","name":"to","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/GetAllInstanceExecutionErrors"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve all executions that have a step execution error, for a formula instance.","tags":["formulas"]}},"/formulas/{formulaId}/instances/executions/errors":{"get":{"operationId":"getFormulasInstancesExecutionsErrors2","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the formula.","format":"int64","in":"path","name":"formulaId","required":true,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"},{"description":"The page size. Defaults to 200 if not provided. Maximum of 200","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"Start time in ISO 8601 format, e.g. '2014-04-14T00:00:00-04:00'. An unspecified time zone defaults to UTC. Defaults to 7 days before end date. Only executions completed (failed or success) after this time will be returned.","in":"query","name":"from","required":false,"type":"string"},{"description":"End time in ISO 8601 format, e.g. '2014-04-14T00:00:00-04:00'. An unspecified time zone defaults to UTC. Only executions completed (failed or success) prior to this time will be returned.","in":"query","name":"to","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/GetAllFormulaExecutionErrors"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve all executions with a step execution error for all formula instances of a formula.","tags":["formulas"]}},"/formulas/{id}":{"delete":{"operationId":"deleteFormulaById","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the formula template.","format":"int64","in":"path","name":"id","required":true,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Delete a specific formula template.","tags":["formulas"]},"get":{"operationId":"getFormulaById","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the formula template.","format":"int64","in":"path","name":"id","required":true,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/GetFormula"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve a specific formula template.","tags":["formulas"]},"put":{"operationId":"replaceFormulaById","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the formula template.","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The formula template.","in":"body","name":"Formula","required":true,"schema":{"$ref":"#/definitions/UpdateFormula"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/GetFormula"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Replace a specific formula template with the provided template.","tags":["formulas"]},"patch":{"operationId":"updateFormulaById","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the formula template.","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The formula template.","in":"body","name":"Formula","required":true,"schema":{"$ref":"#/definitions/PartialUpdateFormula"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/GetFormulaSlim"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"404":{"description":"Not found - The requested resource is not found"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Partially update a formula template's metadata.","tags":["formulas"]}},"/formulas/{id}/configuration":{"post":{"operationId":"createFormulaConfiguration","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the formula template.","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The formula configuration.","in":"body","name":"configuration","required":true,"schema":{"$ref":"#/definitions/CreateConfiguration"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/GetConfiguration"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Create a new formula configuration.","tags":["formulas"]}},"/formulas/{id}/configuration/{configurationId}":{"delete":{"operationId":"deleteFormulasConfigurationByConfigurationId","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the formula template.","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The ID of the formula configuration.","format":"int64","in":"path","name":"configurationId","required":true,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Delete a formula configuration.","tags":["formulas"]},"get":{"operationId":"getFormulasConfigurationByConfigurationId","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the formula template.","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The ID of the formula configuration.","format":"int64","in":"path","name":"configurationId","required":true,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/GetConfiguration"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve a formula configuration.","tags":["formulas"]},"put":{"operationId":"replaceFormulasConfigurationByConfigurationId","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the formula template.","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The ID of the formula configuration.","format":"int64","in":"path","name":"configurationId","required":true,"type":"integer"},{"description":"The formula configuration.","in":"body","name":"configuration","required":true,"schema":{"$ref":"#/definitions/CreateConfiguration"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/GetConfiguration"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Update a formula configuration.","tags":["formulas"]}},"/formulas/{id}/export":{"get":{"operationId":"getFormulasExport","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the formula template.","format":"int64","in":"path","name":"id","required":true,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"type":"string","format":"byte"}},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"404":{"description":"Not found - The requested resource is not found"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Export a formula template as a JSON file.","tags":["formulas"]}},"/formulas/{id}/instances":{"get":{"operationId":"getFormulasInstances2","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the formula template.","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"},{"description":"The page size. Defaults to 200 if not provided. Maximum of 200","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/GetFormulaInstance"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve a list of all instances associated with a particular formula template.","tags":["formulas"]},"post":{"operationId":"createFormulaInstance","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the formula template.","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The formula instance.","in":"body","name":"FormulaInstance","required":true,"schema":{"$ref":"#/definitions/CreateFormulaInstance"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/FormulaInstance"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Create an instance of a formula template.","tags":["formulas"]}},"/formulas/{id}/instances/{instanceId}":{"delete":{"operationId":"deleteFormulasInstanceByInstanceId","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the formula template.","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The ID of the formula instance.","format":"int64","in":"path","name":"instanceId","required":true,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Delete a specific formula instance of a specific formula template.","tags":["formulas"]},"get":{"operationId":"getFormulasInstanceByInstanceId2","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the formula template.","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The ID of the formula instance.","format":"int64","in":"path","name":"instanceId","required":true,"type":"integer"},{"description":"Default false. If true response includes deleted instance","in":"query","name":"includeDeleted","type":"boolean","default":"false","required":false}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/GetFormulaFormulaInstance"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve a specific instance of a specific formula template.","tags":["formulas"]},"put":{"operationId":"replaceFormulasInstanceByInstanceId","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the formula template.","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The ID of the formula instance.","format":"int64","in":"path","name":"instanceId","required":true,"type":"integer"},{"description":"The formula instance.","in":"body","name":"FormulaInstance","required":true,"schema":{"$ref":"#/definitions/CreateFormulaInstance"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/GetFormulaInstance"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Replace a specific formula instance of a specific formula template with the provided instance.","tags":["formulas"]}},"/formulas/{id}/instances/{instanceId}/active":{"put":{"operationId":"replaceFormulasInstancesActive","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the formula template.","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The ID of the formula instance.","format":"int64","in":"path","name":"instanceId","required":true,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Activate a formula instance.","tags":["formulas"]},"delete":{"operationId":"deleteFormulasInstancesActive","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the formula template.","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The ID of the formula instance.","format":"int64","in":"path","name":"instanceId","required":true,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Deactivate a formula instance.","tags":["formulas"]}},"/formulas/{id}/instances/{instanceId}/executions":{"get":{"operationId":"getFormulasInstancesExecutions2","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the formula template.","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The ID of the formula instance.","format":"int64","in":"path","name":"instanceId","required":true,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"},{"description":"The page size. Defaults to 200 if not provided. Maximum of 200","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/FormulaExecution"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve the executions of a specific formula instance of a specific formula template.","tags":["formulas"]}},"/formulas/{id}/steps":{"get":{"operationId":"getFormulasSteps","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the formula template.","format":"int64","in":"path","name":"id","required":true,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/GetStep"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve all formula steps.","tags":["formulas"]},"post":{"operationId":"createFormulaStep","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the formula template.","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The formula step.","in":"body","name":"step","required":true,"schema":{"$ref":"#/definitions/CreateStep"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/GetStep"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Create a new formula step.","tags":["formulas"]}},"/formulas/{id}/steps/{stepId}":{"delete":{"operationId":"deleteFormulasStepByStepId","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the formula template.","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The ID of the formula step.","format":"int64","in":"path","name":"stepId","required":true,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Delete a formula step.","tags":["formulas"]},"get":{"operationId":"getFormulasStepByStepId","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the formula template.","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The ID of the formula step.","format":"int64","in":"path","name":"stepId","required":true,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/GetStep"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve a formula step.","tags":["formulas"]},"put":{"operationId":"replaceFormulasStepByStepId","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the formula template.","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The ID of the formula step.","format":"int64","in":"path","name":"stepId","required":true,"type":"integer"},{"description":"The formula step.","in":"body","name":"step","required":true,"schema":{"$ref":"#/definitions/CreateStep"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/GetStep"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Update a formula step.","tags":["formulas"]}},"/formulas/{id}/triggers":{"post":{"operationId":"createFormulaTrigger","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the formula template.","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The formula trigger.","in":"body","name":"trigger","required":true,"schema":{"$ref":"#/definitions/CreateTrigger"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/GetTrigger"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Create a new formula trigger.","tags":["formulas"]}},"/formulas/{id}/triggers/{triggerId}":{"delete":{"operationId":"deleteFormulasTriggerByTriggerId","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the formula template.","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The ID of the formula trigger.","format":"int64","in":"path","name":"triggerId","required":true,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Delete a formula trigger.","tags":["formulas"]},"get":{"operationId":"getFormulasTriggerByTriggerId","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the formula template.","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The ID of the formula trigger.","format":"int64","in":"path","name":"triggerId","required":true,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/GetTrigger"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve a formula trigger.","tags":["formulas"]},"put":{"operationId":"replaceFormulasTriggerByTriggerId","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the formula template.","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The ID of the formula trigger.","format":"int64","in":"path","name":"triggerId","required":true,"type":"integer"},{"description":"The formula trigger.","in":"body","name":"trigger","required":true,"schema":{"$ref":"#/definitions/CreateTrigger"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/GetTrigger"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Update a formula trigger.","tags":["formulas"]}},"/formulas/{id}/upgrade/v3":{"put":{"operationId":"replaceFormulasUpgradeV3","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the formula template.","format":"int64","in":"path","name":"id","required":true,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/GetFormula"}},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"404":{"description":"Not found - The requested resource is not found"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Upgrade a v1 formula to a v3 formula.","tags":["formulas"]}},"/hubs":{"get":{"operationId":"getHubs","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":false,"type":"string"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"},{"description":"The page size. Defaults to 200 if not provided. Maximum of 200","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/Hub"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve all available element hubs.","tags":["hubs"]},"post":{"operationId":"createHub","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The hub","in":"body","name":"Hub","required":true,"schema":{"$ref":"#/definitions/Hub"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Hub"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Create a new hub.","tags":["hubs"]}},"/hubs/keys":{"get":{"operationId":"getHubsKeys","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":false,"type":"string"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"},{"description":"The page size. Defaults to 200 if not provided. Maximum of 200","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"type":"string"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve all available element hub keys.","tags":["hubs"]}},"/hubs/{key}":{"get":{"operationId":"getHubByKey","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":false,"type":"string"},{"description":"The elements hub key (i.e. 'documents', 'crm', etc.)","in":"path","name":"key","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Hub"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve the details about a specific hub.","tags":["hubs"]}},"/hubs/{key}/elements":{"get":{"operationId":"getHubsElements","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":false,"type":"string"},{"description":"The elements hub key (i.e. 'documents', 'crm', etc.)","in":"path","name":"key","required":true,"type":"string"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"},{"description":"The page size. Defaults to 200 if not provided. Maximum of 200","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/Element"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve all available elements for a specific hub.","tags":["hubs"]}},"/incident-types":{"get":{"operationId":"getIncidentTypes","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for incident types last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all incident types are returned in a paginated fashion.","in":"query","name":"where","required":false,"type":"string"},{"description":"Specify if deleted incidents should be included in the search.","in":"query","name":"includeDeleted","required":false,"type":"boolean"},{"description":"The number of results to return per page","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/IncidentType"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Search for incident type or incident types in the help desk system, using the provided CEQL search expression. The search expression in CEQL is the WHERE clause in a typical SQL query, but without the WHERE keyword. For example, to search for all incident types whose type contains the word 'bug', the search expression parameter will be where=type='%bug%'. Performing a search without these parameters will not return any results.

If a value of true is specified for the includeDeleted flag, then any soft-deleted records will also be considered in the searched records.","tags":["helpdesk"]},"post":{"operationId":"createIncidentType","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The incident type field to create","in":"body","name":"incidentType","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Create a new incident type in the help desk system. Incident type creation will flow through Cloud Elements to the help desk service. If a Incident type already exists will return an error message.","tags":["helpdesk"]}},"/incident-types/{id}":{"delete":{"operationId":"deleteIncidentTypeById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the incident type","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete incident type field from the help desk system.If the incident type does not exist will result in an error message.","tags":["helpdesk"]},"get":{"operationId":"getIncidentTypeById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the incident type","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve Incident type field from the help desk system. Incident type field that does not exist will result in an error response.","tags":["helpdesk"]},"patch":{"operationId":"updateIncidentTypeById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the incident type","in":"path","name":"id","required":true,"type":"string"},{"description":"The IncidentType, containing only the fields to update","in":"body","name":"incidentType","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update incident type in the help desk system. The update API uses the PATCH HTTP verb, so only those fields provided in the incident type object will be updated, and those fields not provided will be left alone. Updating incident type that does not exist will result in an error response.","tags":["helpdesk"]}},"/incidents":{"get":{"operationId":"getIncidents","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for incidents last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all incidents are returned in a paginated fashion.","in":"query","name":"where","required":false,"type":"string"},{"description":"Specify if deleted incidents should be included in the search.","in":"query","name":"includeDeleted","required":false,"type":"boolean"},{"description":"The number of results to return per page","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/Incident"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Search for incidents in the help desk system, using the provided CEQL search expression. The search expression in CEQL is the WHERE clause in a typical SQL query, but without the WHERE keyword. For example, to search for all incidents whose name contains the word 'bug', the search expression parameter will be where=name='%bug%'. Performing a search without these parameters will not return any results.

If a value of true is specified for the includeDeleted flag, then any soft-deleted records will also be considered in the searched records.","tags":["helpdesk"]},"post":{"operationId":"createIncident","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The incident to create","in":"body","name":"incident","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Create a new incident in the help desk system. Incident creation will flow through Cloud Elements to the help desk service. Creating duplicate incidents will return an error message.","tags":["helpdesk"]}},"/incidents/{id}":{"delete":{"operationId":"deleteIncidentById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the incident","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete an incident associated with a given ID from the help desk system. Specifying an incident associated with a given ID that does not exist will result in an error message.","tags":["helpdesk"]},"get":{"operationId":"getIncidentById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the incident","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve an incident associated with a given ID from the help desk system. Specifying an incident with a specified ID that does not exist will result in an error response.","tags":["helpdesk"]},"patch":{"operationId":"updateIncidentById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the incident","in":"path","name":"id","required":true,"type":"string"},{"description":"The incident, containing only the fields to update","in":"body","name":"incident","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update an incident associated with a given ID in the help desk system. The update API uses the PATCH HTTP verb, so only those fields provided in the incident object will be updated, and those fields not provided will be left alone. Updating an incident with a specified ID that does not exist will result in an error response.","tags":["helpdesk"]}},"/incidents/{id}/attachments":{"get":{"operationId":"getIncidentsAttachments","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the incident","in":"path","name":"id","required":true,"type":"string"},{"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for attachments with file name ScreenShot.jpeg the search expression will be where=fileName>='ScreenShot.jpeg'. When this parameter is omitted, all attachments are returned in a paginated fashion.","in":"query","name":"where","required":false,"type":"string"},{"description":"Specify if deleted attachments should be included in the search.","in":"query","name":"includeDeleted","required":false,"type":"boolean"},{"description":"The number of results to return per page","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieves a list of attachments associated with the given incident id.","tags":["helpdesk"]},"put":{"consumes":["multipart/form-data"],"operationId":"replaceIncidentsAttachments","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The file to be uploaded","in":"formData","name":"file","type":"file"},{"description":"The name of the file (e.g. myFile.txt)","in":"query","name":"fileName","required":true,"type":"string"},{"description":"The ID of the incident","in":"path","name":"id","required":true,"type":"string"},{"description":"The description for the attachment to associate with the incident","in":"query","name":"description","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Upload an attachment to an incident associated with a given ID in the help desk system. Adding an attachment to the incident with a specified ID that does not exist will result in an error response.","tags":["helpdesk"]}},"/incidents/{id}/attachments/{attachmentId}":{"delete":{"operationId":"deleteIncidentsAttachmentByAttachmentId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the incident","in":"path","name":"id","required":true,"type":"string"},{"description":"The ID of the attachment","in":"path","name":"attachmentId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete a incident attachment associated with a given ID from the help desk system .Specifying a user associated with a given ID that does not exist will result in an error message.","tags":["helpdesk"]},"get":{"operationId":"getIncidentsAttachmentByAttachmentId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the incident","in":"path","name":"id","required":true,"type":"string"},{"description":"The ID of the attachment","in":"path","name":"attachmentId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieves a specific incident attachment associated with an ID from your helpdesk service.The attachment is directly streamed from the helpdesk provider through Cloud Elements, and is not buffered to disk. Specifying a attachment associated with an ID that does not exist results in an error response.","tags":["helpdesk"]}},"/incidents/{id}/comments":{"get":{"operationId":"getIncidentsComments","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the incident for the comments to be retrived","in":"path","name":"id","required":true,"type":"string"},{"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for comments last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all comments are returned in a paginated fashion.","in":"query","name":"where","required":false,"type":"string"},{"description":"Specify if deleted comments should be included in the search.","in":"query","name":"includeDeleted","required":false,"type":"boolean"},{"description":"The number of results to return per page","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Search for comments for an incident in the help desk system, using the provided CEQL search expression. The search expression in CEQL is the WHERE clause in a typical SQL query, but without the WHERE keyword. For example, to search for all incident comments whose name contains the word 'escalate', the search expression parameter will be where=name='%escalate%'. Performing a search without these parameters will return all the comments in paginated list.

If a value of true is specified for the includeDeleted flag, then any soft-deleted records will also be considered in the searched records.","tags":["helpdesk"]},"put":{"operationId":"replaceIncidentsComments","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the incident","in":"path","name":"id","required":true,"type":"string"},{"description":"The comment, containing the fields to add in incident","in":"body","name":"comment","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"To add comments to an incident associated with a given ID in the help desk system.The add comment API uses the PUT HTTP verb, so only those fields provided in the incident object will be updated, and those fields not provided will be left alone. Updating an incident with a specified ID that does not exist will result in an error response.","tags":["helpdesk"]}},"/incidents/{id}/history":{"get":{"operationId":"getIncidentsHistory","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the incident for the history to be retrived","in":"path","name":"id","required":true,"type":"string"},{"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for comments last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all comments are returned in a paginated fashion.","in":"query","name":"where","required":false,"type":"string"},{"description":"The number of results to return per page","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Search for history for an incident in the help desk system, using the provided CEQL search expression. The search expression in CEQL is the WHERE clause in a typical SQL query, but without the WHERE keyword. For example, to search for all incident history whose type is 'Notification', the search expression parameter will be where=type='Notification'. Performing a search without these parameters will return all the history in paginated list.","tags":["helpdesk"]}},"/incidents/{incidentId}/comments/{commentId}":{"delete":{"operationId":"deleteIncidentsCommentByCommentId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the incident","in":"path","name":"incidentId","required":true,"type":"string"},{"description":"The ID of the comment","in":"path","name":"commentId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete a comment with a given ID for the incident associated with a given ID from the help desk system. Specifying an incident with a specified ID that does not exist or comment with a specified id that does nor exist will result in an error response.","tags":["helpdesk"]},"get":{"operationId":"getIncidentsCommentByCommentId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the incident","in":"path","name":"incidentId","required":true,"type":"string"},{"description":"The ID of the comment","in":"path","name":"commentId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve an incident comment associated with a given ID from the help desk systemSpecifying an incident with a specified ID that does not exist will result in an error response.","tags":["helpdesk"]},"patch":{"operationId":"updateIncidentsCommentByCommentId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the incident","in":"path","name":"id","required":true,"type":"string"},{"description":"The ID of the comment","in":"path","name":"commentId","required":true,"type":"string"},{"description":"The comment, containing the fields to add in incident","in":"body","name":"comment","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"To add comments to an incident associated with a given ID in the help desk system.The add comment API uses the PUT HTTP verb, so only those fields provided in the incident object will be updated, and those fields not provided will be left alone. Updating an incident with a specified ID that does not exist will result in an error response.","tags":["helpdesk"]}},"/incidents/{incidentId}/history/{historyId}":{"get":{"operationId":"getIncidentsHistoryByHistoryId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the incident","in":"path","name":"incidentId","required":true,"type":"string"},{"description":"The ID of the history","in":"path","name":"historyId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve an incident history associated with a given ID from the help desk system. Specifying an incident with a specified ID that does not exist will result in an error response.","tags":["helpdesk"]}},"/instances":{"get":{"operationId":"getInstances","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The tags to search, e.g., development, qa, my sample tag","in":"query","name":"tags[]","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"description":"The CEQL search expression is supported for 'searchText'. For example, To search for instance whose name or element key has 'intercom' in it, the search expression should be where= searchText='intercom'","in":"query","name":"where","required":false,"type":"string"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"},{"description":"The page size. Defaults to 200 if not provided. Maximum of 200","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"default":false,"description":"Retrieve element instance configuration and tag information","in":"query","name":"hydrate","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/ElementInstance"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve all element instances from a specified path. The instances go through Cloud Elements to your console. Specifying an instance that does not exist results in an error response.","tags":["instances"]},"post":{"operationId":"createInstance","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element instance to create","in":"body","name":"elementInstance","required":true,"schema":{"$ref":"#/definitions/ElementInstance"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/ElementInstancePost"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Create a new element instance in your console. Instance creation will flow through Cloud Elements to your console.","tags":["instances"]},"delete":{"operationId":"deleteInstances","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>, Element <token>'","in":"header","name":"Authorization","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Delete an instance associated with an instance token in authorization header. Specifying an instance associated with a given token that does not exist will result in an error message.","tags":["instances"]},"put":{"operationId":"replaceInstances","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>, Element <token>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The fields of the element instance to update","in":"body","name":"elementInstance","required":true,"schema":{"$ref":"#/definitions/ElementInstance"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/ElementInstancePost"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Update an instance associated with a given token in authorization header. Specifying an instance associated with an token that does not exist will result in an error message.","tags":["instances"]},"patch":{"operationId":"updateInstances","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>, Element <token>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The fields of the element instance to update","in":"body","name":"elementInstance","required":true,"schema":{"$ref":"#/definitions/ElementInstanceTokenPatch"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/ElementInstancePatch"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Update an instance partially associated with a given token in authorization header. Specifying an instance associated with an token that does not exist will result in an error message.","tags":["instances"]}},"/instances/configuration":{"get":{"operationId":"getInstancesConfiguration","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>, Element <token>'","in":"header","name":"Authorization","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/ElementInstanceTokenConfigurationGetRes"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve configuration for an element instance with an associated token in authorization header","tags":["instances"]},"patch":{"operationId":"updateInstancesConfiguration","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>, Element <token>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The updated element instance config","in":"body","name":"config","required":true,"schema":{"items":{"$ref":"#/definitions/ElementInstanceConfigurationGetResObject"},"type":"array"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/ElementInstanceTokenConfigurationGetRes"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Update configuration for an element instance with an associated token in authorization header","tags":["instances"]}},"/instances/configuration/{configKeyOrId}":{"get":{"operationId":"getInstancesConfigurationByConfigKeyOrId","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>, Element <token>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The Key Or ID of the element instance config","in":"path","name":"configKeyOrId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/ElementInstanceTokenConfigurationGetRes"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve configuration for an element instance with an associated token in authorization header","tags":["instances"]},"patch":{"operationId":"updateInstancesConfigurationByConfigKeyOrId","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>, Element <token>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The Key Or ID of the element instance config","in":"path","name":"configKeyOrId","required":true,"type":"string"},{"description":"The updated element instance config","in":"body","name":"config","required":true,"schema":{"$ref":"#/definitions/ElementInstanceConfigUpdate"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/ElementInstanceTokenConfigurationPatchRes"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Update configuration for an element instance with an associated token in authorization header","tags":["instances"]}},"/instances/docs":{"get":{"operationId":"getInstancesDocs","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>, Element <token>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The id of the operation for which swagger docs is returned","in":"query","name":"operationId","required":false,"type":"string"},{"description":"The element swagger version to get the corresponding element swagger, Passing in \"-1\" gives latest element swagger","in":"query","name":"version","required":false,"default":"-1","type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/swaggerDocs"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve an instance specific swagger documentation with an associated instance token in authorization header","tags":["instances"]}},"/instances/docs/{operationId}":{"get":{"operationId":"getInstancesDocByOperationId","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>, Element <token>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The id of the operation for which swagger docs is returned","format":"int64","in":"path","name":"operationId","required":true,"type":"string"},{"description":"Include discovery metadata in definitions","in":"query","name":"discovery","required":false,"type":"boolean"},{"description":"Include only OpenAPI / Swagger properties in definitions","in":"query","name":"basic","required":false,"type":"boolean"},{"description":"The element swagger version to get the corresponding element swagger, Passing in \"-1\" gives latest element swagger","in":"query","name":"version","required":false,"default":"-1","type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/swaggerDocs"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve an instance specific swagger documentation for an operation with an associated instance token in authorization header","tags":["instances"]}},"/instances/docs/{operationId}/definitions":{"get":{"operationId":"getInstancesDocsDefinitions","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>, Element <token>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The id of the operation for which swagger docs is returned","format":"int64","in":"path","name":"operationId","required":true,"type":"string"},{"description":"Include discovery metadata in definitions","in":"query","name":"discovery","required":false,"type":"boolean"},{"description":"Optionally resolve swagger references for an inline object definition","in":"query","name":"resolveReferences","required":false,"type":"boolean"},{"description":"Include only OpenAPI / Swagger properties in definitions","in":"query","name":"basic","required":false,"type":"boolean"},{"description":"The element swagger version to get the corresponding element swagger, Passing in \"-1\" gives latest element swagger","in":"query","name":"version","required":false,"default":"-1","type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/SwaggerOperationDefinitions"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve an definitionation for an operation id with an associated instance token in authorization header","tags":["instances"]}},"/instances/enabled":{"put":{"operationId":"replaceInstancesEnabled","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>, Element <token>'","in":"header","name":"Authorization","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Enable an element instance with an associated instance token in authorization header","tags":["instances"]},"delete":{"operationId":"deleteInstancesEnabled","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>, Element <token>'","in":"header","name":"Authorization","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Disable an element instance with an associated instance token in authorization header","tags":["instances"]}},"/instances/event-polling-disabled":{"get":{"operationId":"getInstancesEventPollingDisabled","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/InstancesPollingDisabled"},"type":"array"},"examples":{"application/json":[{"id":1113,"pollingErrorDetails":[{"elementInstanceId":1113,"object":"itemCategories","lastPoll":1603795226553,"lastPollISO8601":"2020-10-27T16:10:26+05:30","quartzJobName":"MjoyOjI6MTExMzptc2J1c2luZXNzY2VudHJhbCAxMTEzIGV2ZW50IHBvbGxlcg","errorCount":100,"errorStartDate":"2020-10-20","firstErrorStatusCode":404,"errorMessage":"{\"requestId\":\"5f8efc6fe4b03d2aa122cbcf\",\"message\":\"Element was not setup properly. This element does not return a root array for its pluralized responses, so a 'rootKey' field is needed to be set on this resource\"}"}]}]}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieves all element instances whose event polling was disabled due to multiple consecutive unsuccessful API calls along with error details of polling","tags":["instances"]}},"/instances/events":{"get":{"operationId":"getInstancesEvents","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/ElementInstanceEvents"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve events for all element instances or for an associated instance token in authorization header","tags":["instances"]}},"/instances/events/analytics":{"get":{"operationId":"getInstancesEventsAnalytics","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"Start time in ISO 8601 format, e.g. '2014-04-14T00:00:00-4:00'. An unspecified time zone defaults to UTC. Defaults to one week prior to the current date.","in":"query","name":"from","required":false,"type":"string"},{"description":"End time in ISO 8601 format, e.g. '2014-04-14T00:00:00-4:00'. An unspecified time zone defaults to UTC. Defaults to the current date.","in":"query","name":"to","required":false,"type":"string"},{"description":"Interval to be sent for the data to be returned, it can be year, quarter, month, week, day, hour, minute, second","enum":["year","quarter","month","week","day","hour","minute","second"],"in":"query","name":"interval","required":false,"type":"string"},{"description":"The comma-separated list of account IDs to search. Only applicable for organization admin. Defaults to current user's account only.'","in":"query","name":"accountIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/AnalyticsEntry"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve the number of events within a given date/time range for all element instances within the specified account(s).","tags":["instances"]}},"/instances/events/analytics/accounts":{"get":{"operationId":"getInstancesEventsAnalyticsAccounts","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"Start time in ISO 8601 format, e.g. '2014-04-14T00:00:00-4:00'. An unspecified time zone defaults to UTC. Defaults to one week prior to the current date.","in":"query","name":"from","required":false,"type":"string"},{"description":"End time in ISO 8601 format, e.g. '2014-04-14T00:00:00-4:00'. An unspecified time zone defaults to UTC. Defaults to the current date.","in":"query","name":"to","required":false,"type":"string"},{"description":"Interval to be sent for the data to be returned, it can be year, quarter, month, week, day, hour, minute, second","enum":["year","quarter","month","week","day","hour","minute","second"],"in":"query","name":"interval","required":false,"type":"string"},{"description":"The comma-separated list of account IDs to search. Only applicable for organization admins. Defaults to current user's account only.'","in":"query","name":"accountIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/AccountAnalyticsEntry"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve the number of events within a given date/time range, aggregated by account ID. This API is really only useful for organization admins where more than one account exists.","tags":["instances"]}},"/instances/events/analytics/instances":{"get":{"operationId":"getInstancesEventsAnalyticsInstances","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"Start time in ISO 8601 format, e.g. '2014-04-14T00:00:00-4:00'. An unspecified time zone defaults to UTC. Defaults to one week prior to the current date.","in":"query","name":"from","required":false,"type":"string"},{"description":"End time in ISO 8601 format, e.g. '2014-04-14T00:00:00-4:00'. An unspecified time zone defaults to UTC. Defaults to the current date.","in":"query","name":"to","required":false,"type":"string"},{"description":"Interval to be sent for the data to be returned, it can be year, quarter, month, week, day, hour, minute, second","enum":["year","quarter","month","week","day","hour","minute","second"],"in":"query","name":"interval","required":false,"type":"string"},{"description":"The comma-separated list of account IDs to search. Only applicable for organization admins. Defaults to current user's account only.'","in":"query","name":"accountIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/InstanceAnalyticsEntry"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve the number of events within a given date/time range, aggregated by element instance ID.","tags":["instances"]}},"/instances/events/dispositions":{"get":{"operationId":"getInstancesEventsDispositions","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"Start time in ISO 8601 format, e.g. '2014-04-14T00:00:00-4:00'. An unspecified time zone defaults to UTC. Defaults to one week prior to the current date.","in":"query","name":"from","required":false,"type":"string"},{"description":"End time in ISO 8601 format, e.g. '2014-04-14T00:00:00-4:00'. An unspecified time zone defaults to UTC. Defaults to the current date.","in":"query","name":"to","required":false,"type":"string"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"},{"description":"The page size. Defaults to 200 if not provided. Maximum of 200","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/ElementInstanceEventsDispositions"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve events for all element instances or for an associated instance token in authorization header","tags":["instances"]}},"/instances/events/{eventId}":{"get":{"operationId":"getInstancesEventByEventId","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the event","in":"path","name":"eventId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/ElementInstanceEventsObject"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve an event for all element instances or for an associated instance token in authorization header","tags":["instances"]}},"/instances/objects/definitions":{"get":{"operationId":"getInstancesObjectsDefinitions","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>, Element <token>'","in":"header","name":"Authorization","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/ElementInstanceObjectDefinitionsList"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve all of the object definitions within a specific instance with an associated instance token in authorization header. If no object definitions exist, then this will result in an error response.","tags":["instances"]}},"/instances/objects/{objectName}/definitions":{"delete":{"operationId":"deleteInstancesObjectsObjectNameDefinitions","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>, Element <token>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Delete an object definition associated with an objectName for a specific instance with an associated instance token in authorization header. Specifying an object name that does not have an object definition will result in an error response.","tags":["instances"]},"get":{"operationId":"getInstancesObjectsObjectNameDefinitions","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>, Element <token>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/ElementInstanceObjectDefinitionsListVdrName"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve a specific object definition associated with an objectName within a specific instance with an associated instance token in authorization header. Specifying an object definition associated with a given objectName that does not exist will result in an error response.","tags":["instances"]},"post":{"operationId":"createInstanceObjectObjectNameDefinition","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>, Element <token>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The object definition","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Definition"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/ElementInstanceObjectDefinitionsListVdrName"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Create a new object definition associated with an objectName within a specific instance with an associated instance token in authorization header. The definitions allow you to define what an object looks like within an instance.","tags":["instances"]},"put":{"operationId":"replaceInstancesObjectsObjectNameDefinitions","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>, Element <token>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The object definition","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Definition"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/ElementInstanceObjectDefinitionsListVdrName"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Update a specific object's definition associated with an objectName within a specific instance with an associated instance token in authorization header. Specifying an object definition associated with a given objectName that does not exist will result in an error response.","tags":["instances"]}},"/instances/trace-logging":{"put":{"operationId":"replaceInstancesTraceLogging","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>, Element <token>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"Optional body containing configuration (e.g. duration) for enabling trace-level logging.","in":"body","name":"config","required":false,"schema":{"$ref":"#/definitions/TraceLoggingConfig"}}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Temporarily enable trace-level usage logging for an element instance with an associated instance token in authorization header","tags":["instances"]},"delete":{"operationId":"deleteInstancesTraceLogging","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>, Element <token>'","in":"header","name":"Authorization","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Disable trace-level usage logging for an element instance with an associated instance token in authorization header","tags":["instances"]}},"/instances/transformations":{"delete":{"operationId":"deleteInstancesTransformations","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>, Element <token>'","in":"header","name":"Authorization","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Delete the transformation for an element instance with an associated instance token in authorization header","tags":["instances"]},"get":{"operationId":"getInstancesTransformations","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>, Element <token>'","in":"header","name":"Authorization","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/ElementInstanceTransformationsList"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve an element instance transformation with an associated instance token in authorization header","tags":["instances"]}},"/instances/transformations/{objectName}":{"delete":{"operationId":"deleteInstancesTransformationByObjectName","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>, Element <token>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Delete the transformation for an element instance for a specific object with an associated instance token in authorization header","tags":["instances"]},"get":{"operationId":"getInstancesTransformationByObjectName","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>, Element <token>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/ElementInstanceTransformationsListVdrName"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve an element instance transformation for a specific object with an associated instance token in authorization header","tags":["instances"]},"post":{"operationId":"createInstanceTransformationByObjectName","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>, Element <token>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The transformation to create","in":"body","name":"transformation","required":true,"schema":{"$ref":"#/definitions/Transformation"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/ElementInstanceTransformationsListVdrName"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Create a transformation for an element instance for a specific object","tags":["instances"]},"put":{"operationId":"replaceInstancesTransformationByObjectName","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>, Element <token>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The transformation to update","in":"body","name":"transformation","required":true,"schema":{"$ref":"#/definitions/Transformation"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/ElementInstanceTransformationsListVdrName"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Update the transformation for an element instance for a specific object with an associated instance token in authorization header","tags":["instances"]}},"/instances/validate":{"post":{"operationId":"createInstanceValidate","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The validate instances body. Maximum of 50 instances can be validated at once","in":"body","name":"validatePostbody","required":true,"schema":{"$ref":"#/definitions/validatePostReq"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/ElementInstanceValidatePostRes"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"429":{"description":"Too Many Requests - Too many requests in a given amount of time "},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Validates the instances provided in the body using /ping api in the element.","tags":["instances"]}},"/instances/validate-cancel":{"delete":{"operationId":"deleteInstancesValidateCancel","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Cancels the ongoing instance validation process","tags":["instances"]}},"/instances/validate-status":{"get":{"operationId":"getInstancesValidateStatus","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/ElementInstanceValidateStatus"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Validates the instances provided in the body using /ping api in the element.","tags":["instances"]}},"/instances/{id}":{"delete":{"operationId":"deleteInstanceById","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the element instance","format":"int64","in":"path","name":"id","required":true,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Delete an instance associated with a given ID from your console. Specifying an instance associated with a given ID that does not exist will result in an error message.","tags":["instances"]},"get":{"operationId":"getInstanceById","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the element instance","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"Default false. If true the response will only return the deleted instance. If specified instance is not deleted, the api will return a 404","in":"query","name":"includeDeleted","type":"boolean","default":"false","required":false}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/ElementInstanceGetById"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve an element instance associated with a given ID from a specified path. The instance goes through Cloud Elements to your console. Specifying an instance with an associated ID that does not exist results in an error response.","tags":["instances"]},"put":{"operationId":"replaceInstanceById","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the element instance","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The fields of the element instance to update","in":"body","name":"elementInstance","required":true,"schema":{"$ref":"#/definitions/ElementInstance"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/ElementInstancePost"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Update an instance associated with a given ID from your console. Specifying an instance associated with an ID that does not exist will result in an error message.","tags":["instances"]},"patch":{"operationId":"updateInstanceById","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the element instance","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The fields of the element instance to update","in":"body","name":"elementInstance","required":true,"schema":{"$ref":"#/definitions/ElementInstance"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/ElementInstancePatch"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Update an instance partially associated with a given ID from your console. Specifying an instance associated with an ID that does not exist will result in an error message.","tags":["instances"]}},"/instances/{id}/configuration":{"get":{"operationId":"getInstancesConfiguration2","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the element instance","format":"int64","in":"path","name":"id","required":true,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/ElementInstanceConfigurationGetRes"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve configuration for an element instance","tags":["instances"]},"patch":{"operationId":"updateInstancesConfiguration2","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>, Element <token>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the element instance","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The updated element instance config","in":"body","name":"config","required":true,"schema":{"items":{"$ref":"#/definitions/ElementInstanceConfigurationGetResObject"},"type":"array"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/ElementInstanceConfigurationGetRes"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Update configuration for an element instance with an associated token in authorization header","tags":["instances"]}},"/instances/{id}/configuration/{configKeyOrId}":{"get":{"operationId":"getInstancesConfigurationByConfigKeyOrId2","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the element instance","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The Key Or ID of the element instance config","in":"path","name":"configKeyOrId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/ElementInstanceConfigurationGetResObject"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve configuration for an element instance","tags":["instances"]},"patch":{"operationId":"updateInstancesConfigurationByConfigKeyOrId2","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the element instance","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The Key Or ID of the element instance config","in":"path","name":"configKeyOrId","required":true,"type":"string"},{"description":"The updated element instance config","in":"body","name":"config","required":true,"schema":{"$ref":"#/definitions/ElementInstanceConfigUpdate"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/ElementInstanceConfigurationGetResObject"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Update configuration for an element instance","tags":["instances"]}},"/instances/{id}/docs":{"get":{"operationId":"getInstancesDocs2","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the element instance","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The id of the operation for which swagger docs is returned","in":"query","name":"operationId","required":false,"type":"string"},{"description":"The element swagger version to get the corresponding element swagger, Passing in \"-1\" gives latest element swagger","in":"query","name":"version","required":false,"default":"-1","type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/swaggerDocs"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve an instance specific swagger documentation","tags":["instances"]}},"/instances/{id}/docs/{operationId}":{"get":{"operationId":"getInstancesDocByOperationId2","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the element instance","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The id of the operation for which swagger docs is returned","format":"int64","in":"path","name":"operationId","required":true,"type":"string"},{"description":"Include discovery metadata in definitions","in":"query","name":"discovery","required":false,"type":"boolean"},{"description":"Include only OpenAPI / Swagger properties in definitions","in":"query","name":"basic","required":false,"type":"boolean"},{"description":"The element swagger version to get the corresponding element swagger, Passing in \"-1\" gives latest element swagger","in":"query","name":"version","required":false,"default":"-1","type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/swaggerDocs"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve an instance specific swagger documentation","tags":["instances"]}},"/instances/{id}/docs/{operationId}/definitions":{"get":{"operationId":"getInstancesDocsDefinitions2","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the element instance","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The id of the operation for which swagger docs is returned","format":"int64","in":"path","name":"operationId","required":true,"type":"string"},{"description":"Include discovery metadata in definitions","in":"query","name":"discovery","required":false,"type":"boolean"},{"description":"Optionally resolve swagger references for an inline object definition","in":"query","name":"resolveReferences","required":false,"type":"boolean"},{"description":"Include only OpenAPI / Swagger properties in definitions","in":"query","name":"basic","required":false,"type":"boolean"},{"description":"The element swagger version to get the corresponding element swagger, Passing in \"-1\" gives latest element swagger","in":"query","name":"version","required":false,"default":"-1","type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/SwaggerOperationDefinitions"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve an instance specific swagger documentation","tags":["instances"]}},"/instances/{id}/enabled":{"put":{"operationId":"replaceInstancesEnabled2","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the element instance","format":"int64","in":"path","name":"id","required":true,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Enable an element instance","tags":["instances"]},"delete":{"operationId":"deleteInstancesEnabled2","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the element instance","format":"int64","in":"path","name":"id","required":true,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Disable an element instance","tags":["instances"]}},"/instances/{id}/events":{"get":{"operationId":"getInstancesEvents2","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the element instance","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/ElementInstanceEvents"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve events for an element instance","tags":["instances"]}},"/instances/{id}/events/{eventId}":{"get":{"operationId":"getInstancesEventByEventId2","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the element instance","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The ID of the event","in":"path","name":"eventId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/ElementInstanceEventsObject"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve an event for an element instance","tags":["instances"]}},"/instances/{id}/objects/definitions":{"get":{"operationId":"getInstancesObjectsDefinitions2","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the instance","format":"int64","in":"path","name":"id","required":true,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/ElementInstanceObjectDefinitionsList"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve all of the object definitions at all levels that could map to a specific instance. If no object definitions exist, then this will result in an error response.","tags":["instances"]}},"/instances/{id}/objects/{objectName}/definitions":{"delete":{"operationId":"deleteInstancesObjectsObjectNameDefinitions2","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the instance","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Delete an object definition associated with an objectName for a specific instance. Specifying an object name that does not have an object definition will result in an error response.","tags":["instances"]},"get":{"operationId":"getInstancesObjectsObjectNameDefinitions2","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the instance","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/ElementInstanceObjectDefinitionsListVdrName"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve a specific object definition associated with an objectName within a specific instance. Specifying an object definition associated with a given objectName that does not exist will result in an error response.","tags":["instances"]},"post":{"operationId":"createInstanceObjectObjectNameDefinition2","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the instance","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The object definition","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Definition"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/ElementInstanceObjectDefinitionsListVdrName"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Create a new object definition associated with an objectName within a specific instance. The definitions allow you to define what an object looks like within an instance.","tags":["instances"]},"put":{"operationId":"replaceInstancesObjectsObjectNameDefinitions2","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the instance","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The object definition","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Definition"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/ElementInstanceObjectDefinitionsListVdrName"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Update a specific object's definition associated with an objectName within a specific instance. Specifying an object definition associated with a given objectName that does not exist will result in an error response.","tags":["instances"]}},"/instances/{id}/trace-logging":{"put":{"operationId":"replaceInstancesTraceLogging2","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the element instance","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"Optional body containing configuration (e.g. duration) for enabling trace-level logging.","in":"body","name":"config","required":false,"schema":{"$ref":"#/definitions/TraceLoggingConfig"}}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Temporarily enable trace-level usage logging for an element instance","tags":["instances"]},"delete":{"operationId":"deleteInstancesTraceLogging2","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the element instance","format":"int64","in":"path","name":"id","required":true,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Disable trace-level usage logging for an element instance","tags":["instances"]}},"/instances/{id}/transformations":{"delete":{"operationId":"deleteInstancesTransformations2","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the element instance","format":"int64","in":"path","name":"id","required":true,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Delete the transformation for an element instance","tags":["instances"]},"get":{"operationId":"getInstancesTransformations2","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the element instance","format":"int64","in":"path","name":"id","required":true,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/ElementInstanceTransformationsList"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve an element instance transformation","tags":["instances"]}},"/instances/{id}/transformations/{objectName}":{"delete":{"operationId":"deleteInstancesTransformationByObjectName2","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the element instance","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Delete the transformation for an element instance for a specific object","tags":["instances"]},"get":{"operationId":"getInstancesTransformationByObjectName2","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the element instance","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/ElementInstanceTransformationsListVdrName"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve an element instance transformation for a specific object","tags":["instances"]},"post":{"operationId":"createInstanceTransformationByObjectName2","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the element instance","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The transformation to create","in":"body","name":"transformation","required":true,"schema":{"$ref":"#/definitions/Transformation"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/ElementInstanceTransformationsListVdrName"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Create a transformation for an element instance for a specific object","tags":["instances"]},"put":{"operationId":"replaceInstancesTransformationByObjectName2","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the element instance","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The transformation to update","in":"body","name":"transformation","required":true,"schema":{"$ref":"#/definitions/Transformation"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/ElementInstanceTransformationsListVdrName"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Update the transformation for an element instance for a specific object","tags":["instances"]}},"/invoices":{"get":{"operationId":"getInvoices","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for accounts last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all invoices are returned as defined by the paging","in":"query","name":"where","required":false,"type":"string"},{"description":"The page size for pagination, which defaults to 200 if not supplied","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/Invoice"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Find Invoices in the Finance System, using the provided CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for Invoices last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all Invoices are returned.","tags":["finance"]},"post":{"operationId":"createInvoice","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The Invoice object to be created.
With the exception of the 'id' field, the required fields indicated in the 'Invoice' model are those required to create a new invoice","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Create an Invoice in the Finance system. Invoice creation will flow through Cloud Elements to the Finance Service.","tags":["finance"]}},"/invoices/{id}":{"delete":{"operationId":"deleteInvoiceById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the invoice to delete in the Finance system.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete an Invoice associated with a given ID from the Finance system. Specifying an Invoice associated with a given ID that does not exist will result in an error message.","tags":["finance"]},"get":{"operationId":"getInvoiceById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The Id of the invoice to retrieve from the finance system.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve an Invoice associated with a given ID from the Finance system. Specifying an Invoice with an associated ID that does not exist will result in an error response.","tags":["finance"]},"patch":{"operationId":"updateInvoiceById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the invoice to update in the Finance system.","in":"path","name":"id","required":true,"type":"string"},{"description":"The invoice object, with those fields that are to be updated.","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update an Invoice given a set of partial attributes associated with a given ID in the Finance system. The update API uses the PATCH HTTP verb, so only those fields provided in the Invoice object will be updated, and those fields not provided will be left alone. Updating an Invoice with a specified ID that does not exist will result in an error response.","tags":["finance"]}},"/invoices/{invoiceId}":{"delete":{"operationId":"deleteInvoiceByInvoiceId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The invoice ID","in":"path","name":"invoiceId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete an invoice","tags":["erp"]},"get":{"operationId":"getInvoiceByInvoiceId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The invoice ID","in":"path","name":"invoiceId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve an invoice","tags":["erp"]},"patch":{"operationId":"updateInvoiceByInvoiceId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The invoice ID","in":"path","name":"invoiceId","required":true,"type":"string"},{"description":"The invoice","in":"body","name":"invoice","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update an invoice","tags":["erp"]}},"/jobs":{"get":{"tags":["jobs"],"summary":"Get a list of all configured jobs.","operationId":"getJobs","consumes":[],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Jobs"},"examples":{"application/json":[{"disallowConcurrent":true,"data":{"elementKey":"sfdc","topic":"event.poller","id":1317},"name":"Scheduled Event Poller","description":"sfdc 1317 event poller","id":"MToxOjE6MTMxNzpzZmRjIDEzMTcgZXZlbnQgcG9sbGVy","trigger":{"calendarName":null,"mayFireAgain":true,"nextFireTime":61460395504492,"description":null,"startTime":61460395504492,"id":"MToxOjE6MTMxNzpzZmRjIDEzMTcgZXZlbnQgcG9sbGVyTrigger","endTime":null,"state":"NORMAL","priority":0}}]}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}}},"post":{"tags":["jobs"],"summary":"Create a new job.","description":"","operationId":"createJob","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"body","in":"body","schema":{"$ref":"#/definitions/Createjob","example":{"instanceId":"1340","name":"Sample API Job","description":"First Job","method":"GET","body":{"name":"ss","firstName":"Atul","lastName":"Barve"},"headers":{"SampleHeader":"Passed to API if needed"},"query":{"page":1,"pageSize":20,"where":"id = 1"},"uri":"/elements/api-v2/hubs/messaging/message","trigger":{"cron":"0 0/15 * 1/1 * ? *","simple":"This is not Implemented yet - So Only CROn is Valid"}}}},{"name":"Authorization","in":"header","description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","required":true,"type":"string"}],"responses":{"200":{"description":"","schema":{"$ref":"#/definitions/CreatedJob"},"examples":{"application/json":{"schedule":"0 0/15 * 1/1 * ? *","name":"First Job","id":"MToxOjE6MTM0MDpTYW1wbGUgQVBJIEpvYg"}}},"400":{"description":"","schema":{"type":"object","properties":{"requestId":{"type":"string"},"message":{"type":"string"}}},"examples":{"application/json":{"requestId":"5772b89187888f83733ca0d0","message":"Minimum interval is 15 minutes. Please change the CRON expression: '0 0/5 * 1/1 * ? *'"}}},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}}}},"/jobs/event-polling-disabled":{"get":{"tags":["jobs"],"summary":"Get a list of all polling jobs along with error details, associated with element instances whose event polling was disabled/suspended due to multiple consecutive unsuccessful API calls ","operationId":"getJobsEventPollingDisabled","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/JobsPollingDisabled"},"examples":{"application/json":[{"id":"MjoyOjI6asdasdasdmFsIDkxMCBldmVudCBwb2xsZXI","pollingErrorDetails":[{"elementInstanceId":910,"object":"itemCategories","lastPoll":1602435436397,"lastPollISO8601":"2020-10-11T22:27:16+05:30","quartzJobName":"MjoyOjI6asdasdasdmFsIDkxMCBldmVudCBwb2xsZXI","errorCount":100,"firstErrorStatusCode":404,"errorMessage":"{\"requestId\":\"5f8efc6fe4b03d2aa122cbcf\",\"message\":\"Element was not setup properly. This element does not return a root array for its pluralized responses, so a 'rootKey' field is needed to be set on this resource\"}"}]}]}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}}}},"/jobs/executions":{"get":{"deprecated":true,"tags":["jobs"],"summary":"Get a list of the previous job executions.","operationId":"getJobsExecutions","consumes":["application/json"],"produces":["application/json"],"parameters":[{"description":"The page size. Defaults to 200 if not provided. Maximum of 200","name":"pageSize","in":"query","type":"integer","format":"int64"},{"description":"The list of element keys to include.","name":"elementKeys[]","in":"query","type":"string"},{"description":"The earliest start time to retrieve.","name":"startTime","in":"query","type":"string"},{"description":"The latest end time to retrieve.","name":"endTime","in":"query","type":"string"},{"name":"Authorization","in":"header","description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","type":"string"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/JobExecutions"},"examples":{"application/json":[{"job_class_name":"com.cloudelements.framework.scheduling.ApiScheduledJob","start_time":1463010533017,"job_name":"MToxOjE6MDpGb3JtdWxhLTIwMTctMTg2Nw","job_group":"1:1","job_history_id":19300,"end_time":1463010533167,"job_data":"{\n \"accountId\" : 1,\n \"companyId\" : 1,\n \"method\" : \"POST\",\n \"requestUri\" : \"/elements/api-v2/formulas/2017/instances/1867/executions\",\n \"userId\" : 1\n}","description":"The manual formula execution job for formula 2017, instance 1867","job_error_message":null,"element_key":null,"job_state":"COMPLETED"}]}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}}}},"/jobs/{id}":{"delete":{"tags":["jobs"],"summary":"Delete a specific job.","operationId":"deleteJobById","consumes":["application/json"],"produces":[],"parameters":[{"description":"The ID of the job.","name":"id","in":"path","required":true,"type":"string"},{"name":"Authorization","in":"header","description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}}},"get":{"tags":["jobs"],"summary":"Get information about a specific job.","operationId":"getJobById","consumes":[],"produces":["application/json"],"parameters":[{"description":"The ID of the job.","name":"id","in":"path","required":true,"type":"string"},{"name":"Authorization","in":"header","description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Job"},"examples":{"application/json":{"disallowConcurrent":true,"data":{"elementKey":"sfdc","topic":"event.poller","id":1317},"name":"Scheduled Event Poller","description":"sfdc 1317 event poller","id":"MToxOjE6MTMxNzpzZmRjIDEzMTcgZXZlbnQgcG9sbGVy","trigger":{"calendarName":null,"mayFireAgain":true,"nextFireTime":61460395504492,"description":null,"startTime":61460395504492,"id":"MToxOjE6MTMxNzpzZmRjIDEzMTcgZXZlbnQgcG9sbGVyTrigger","endTime":null,"state":"NORMAL","priority":0}}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}}}},"/jobs/{id}/disable":{"put":{"tags":["jobs"],"summary":"Disable a job.","operationId":"replaceJobsDisable","consumes":["application/json"],"produces":[],"parameters":[{"description":"The ID of the job.","name":"id","in":"path","required":true,"type":"string"},{"name":"Authorization","in":"header","description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}}}},"/jobs/{id}/enable":{"put":{"tags":["jobs"],"summary":"Enable a job.","operationId":"replaceJobsEnable","consumes":["application/json"],"produces":[],"parameters":[{"description":"The ID of the job.","name":"id","in":"path","required":true,"type":"string"},{"name":"Authorization","in":"header","description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}}}},"/jobs/{id}/history":{"get":{"tags":["jobs"],"summary":"Get a list of history records for a specific job.","operationId":"getJobsHistory","consumes":[],"produces":["application/json"],"parameters":[{"description":"The ID of the job.","name":"id","in":"path","required":true,"type":"string"},{"name":"Authorization","in":"header","description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","required":true,"type":"string"},{"description":"The page size. Defaults to 200 if not provided. Maximum of 200","name":"pageSize","in":"query","type":"integer","format":"int64"},{"in":"query","name":"nextPage","description":"The next page cursor, taken from the response header: `elements-next-page-token`","type":"string","required":false},{"description":"The list of element keys to include.","name":"elementKeys[]","in":"query","type":"string"},{"description":"The earliest start time to retrieve.","name":"startTime","in":"query","type":"string"},{"description":"The latest end time to retrieve.","name":"endTime","in":"query","type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/JobHistories"},"examples":{"application/json":[{"job_class_name":"com.cloudelements.framework.scheduling.ApiScheduledJob","company_id":1,"created_dt":1463032133018,"job_group":"1:1","job_history_id":19300,"end_time":1463010533167,"description":"The manual formula execution job for formula 2017, instance 1867","external_id":"some-id","job_state":"COMPLETED","start_time":1463010533017,"account_id":1,"instance_id":0,"job_name":"MToxOjE6MDpGb3JtdWxhLTIwMTctMTg2Nw","user_id":1,"updated_dt":1463010533168,"job_data":"{\n \"accountId\" : 1,\n \"companyId\" : 1,\n \"method\" : \"POST\",\n \"requestUri\" : \"/elements/api-v2/formulas/2017/instances/1867/executions\",\n \"userId\" : 1\n}","job_error_message":"error, if one exists"}]}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}}}},"/jobs/{id}/history/{historyId}":{"get":{"tags":["jobs"],"summary":"Get a specific history record for a specific job.","description":"","operationId":"getJobsHistoryByHistoryId","consumes":[],"produces":["application/json"],"parameters":[{"description":"The ID of the job.","name":"id","in":"path","required":true,"type":"string"},{"description":"The ID of the History record.","name":"historyId","in":"path","required":true,"type":"string"},{"name":"Authorization","in":"header","description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/JobHistory"},"examples":{"application/json":{"job_class_name":"com.cloudelements.framework.scheduling.ApiScheduledJob","company_id":1,"created_dt":1463032133018,"job_group":"1:1","job_history_id":19300,"end_time":1463010533167,"description":"The manual formula execution job for formula 2017, instance 1867","external_id":"some-id","job_state":"COMPLETED","start_time":1463010533017,"account_id":1,"instance_id":0,"job_name":"MToxOjE6MDpGb3JtdWxhLTIwMTctMTg2Nw","user_id":1,"updated_dt":1463010533168,"job_data":"{\n \"accountId\" : 1,\n \"companyId\" : 1,\n \"method\" : \"POST\",\n \"requestUri\" : \"/elements/api-v2/formulas/2017/instances/1867/executions\",\n \"userId\" : 1\n}","job_error_message":"error, if one exists"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}}}},"/jobs/{id}/reschedule":{"patch":{"consumes":["application/json"],"description":"","operationId":"updateJobsReschedule","parameters":[{"description":"The ID of the job.","name":"id","in":"path","required":true,"type":"string"},{"name":"body","in":"body","schema":{"$ref":"#/definitions/Reschedule","example":{"trigger":{"cron":"0 0/15 * * * ?"}}}},{"name":"Authorization","in":"header","description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/CreatedJob"},"examples":{"application/json":{"schedule":"0 0/15 * * * ?","name":"sfdc 1317 event poller","id":"MToxOjE6MTMxNzpzZmRjIDEzMTcgZXZlbnQgcG9sbGVy"}}},"400":{"description":"Bad Request - Often due to a missing or invalid request parameter","schema":{"type":"object","properties":{"requestId":{"type":"string"},"message":{"type":"string"}}},"examples":{"application/json":{"requestId":"57719063d4c6a74d2352b2ce","message":"Minimum interval is 15 minutes. Please change the CRON expression: '0 0/5 * * * ?'"}}},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Update a job's CRON string and reschedule it.","tags":["jobs"]}},"/journal-entries":{"get":{"operationId":"getJournalEntries","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for accounts last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all accounts are returned ","in":"query","name":"where","required":false,"type":"string"},{"description":"The page size for pagination, which defaults to 200 if not supplied","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/JournalEntry"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Find Journal Entries in the Finance System, using the provided CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for Ledger Accounts last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all Ledger Accounts are returned.","tags":["finance"]},"post":{"operationId":"createJournalEntry","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The Journal Entry object to be created.
With the exception of the 'id' field, the required fields indicated in the 'JournalEntry' model are those required to create a new journal entry","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Create a Journal Entry in the Finance system. Journal Entry creation will flow through Cloud Elements to the Finance Service.","tags":["finance"]}},"/journal-entries/{id}":{"delete":{"operationId":"deleteJournalEntryById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the journal entry to delete in the Finance system.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete a Journal Entry associated with a given ID from the Finance system. This deletes the Journal Entry. Specifying a Journal Entry associated with a given ID that does not exist will result in an error message.","tags":["finance"]},"get":{"operationId":"getJournalEntryById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The Id of the journal entry to retrieve from the finance system.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve a Journal Entry associated with a given ID from the Finance system. Specifying a Journal Entry with an associated ID that does not exist will result in an error response.","tags":["finance"]},"patch":{"operationId":"updateJournalEntryById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the journal entry to update in the Finance system.","in":"path","name":"id","required":true,"type":"string"},{"description":"The journal entry object, with those fields that are to be updated.","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update a Journal Entry given a set of partial attributes associated with a given ID in the Finance system. The update API uses the PATCH HTTP verb, so only those fields provided in the Customer object will be updated, and those fields not provided will be left alone. Updating an Customer with a specified ID that does not exist will result in an error response.","tags":["finance"]}},"/journal-entries/{journalEntryId}":{"delete":{"operationId":"deleteJournalEntryByJournalEntryId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The journal entry ID","in":"path","name":"journalEntryId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete a journal entry","tags":["erp"]},"get":{"operationId":"getJournalEntryByJournalEntryId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The journal entry ID","in":"path","name":"journalEntryId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve a journal entry","tags":["erp"]},"patch":{"operationId":"updateJournalEntryByJournalEntryId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The journal entry ID","in":"path","name":"journalEntryId","required":true,"type":"string"},{"description":"The journal entry","in":"body","name":"journalEntry","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update a journal entry","tags":["erp"]}},"/leads":{"get":{"operationId":"getLeads","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for leads last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all leads are returned in a paginated fashion.","in":"query","name":"where","required":false,"type":"string"},{"description":"The page size for pagination, which defaults to 200 if not supplied","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"Specify if deleted leads should be included in the search.","in":"query","name":"includeDeleted","required":false,"type":"boolean"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/Lead"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Find leads in the Marketing Automation system, using the provided CEQL search expression. The search expression in CEQL is the WHERE clause in a typical SQL query, but without the WHERE keyword. For example, to search for all leads whose name contains the word 'data', the search expression parameter will be where=name like '%data%'. If a search expression is not provided, then the first 200 records will be returned.

If a value of true is specified for the includeDeleted flag, then any soft-deleted records will also be considered in the searched records.","tags":["marketing"]},"post":{"operationId":"createLead","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The lead object to be created.
With the exception of the 'id' field, the required fields indicated in the 'Lead' model are those required to create a new lead.","in":"body","name":"lead","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Create a new lead in the Marketing Automation service. Lead creation will flow through Cloud Elements to your Marketing Automation service. With the exception of the 'id' field, the required fields indicated in the 'Lead' model are those required to create a new lead.","tags":["marketing"]}},"/leads/{id}":{"delete":{"operationId":"deleteLeadById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the lead to delete in the Marketing Automation system.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete a lead associated with a given ID from your Marketing Automation system. Specifying a lead associated with a given ID that does not exist will result in an error message.","tags":["marketing"]},"get":{"operationId":"getLeadById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the lead to retrieve from the Marketing Automation system.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve a lead associated with a given ID from your Marketing Automation system. Specifying a lead associated with a given ID that does not exist will result in an error response.","tags":["marketing"]},"patch":{"operationId":"updateLeadById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the lead to update in the Marketing Automation system.","in":"path","name":"id","required":true,"type":"string"},{"description":"The lead object, with those fields that are to be updated.","in":"body","name":"lead","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update the lead associated with the given ID in the Marketing Automation system. The update API uses the PATCH HTTP verb, so only those fields provided in the lead object will be updated, and those fields not provided will be left alone.","tags":["marketing"]}},"/leads/{leadId}":{"delete":{"operationId":"deleteLeadByLeadId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The lead ID","in":"path","name":"leadId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete a lead","tags":["erp"]},"get":{"operationId":"getLeadByLeadId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The lead ID","in":"path","name":"leadId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve a lead","tags":["erp"]},"patch":{"operationId":"updateLeadByLeadId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The lead ID","in":"path","name":"leadId","required":true,"type":"string"},{"description":"The lead","in":"body","name":"lead","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update a lead","tags":["erp"]}},"/ledger-accounts":{"get":{"operationId":"getLedgerAccounts","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for accounts last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all accounts are returned ","in":"query","name":"where","required":false,"type":"string"},{"description":"The page size for pagination, which defaults to 200 if not supplied","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/LedgerAccount"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Find Ledger Accounts in the Finance System, using the provided CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for Ledger Accounts last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all Ledger Accounts are returned.","tags":["finance"]}},"/ledger-accounts/{id}":{"get":{"operationId":"getLedgerAccountById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The Id of the ledger account to retrieve from the finance system.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve a Ledger Account associated with a given ID from the Finance system. Specifying a Ledger Account method with an associated ID that does not exist will result in an error response.","tags":["finance"]}},"/ledger-accounts/{ledgerAccountId}":{"get":{"operationId":"getLedgerAccountByLedgerAccountId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ledger account ID","in":"path","name":"ledgerAccountId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve a ledger account","tags":["erp"]}},"/lists":{"get":{"operationId":"getLists","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The page size for pagination, which defaults to 200 if not supplied","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"items":{},"type":"array"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve a list's metadata from the Marketing Automation system","tags":["marketing"]},"post":{"operationId":"createList","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The list object to be created.
With the exception of the 'id' field, the required fields indicated in the 'List' model are those required to create a new List.","in":"body","name":"list","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Create a new list in the Marketing Automation system with the desired fields and upload a CSV file to populate your new list.","tags":["marketing"]}},"/lists/{id}":{"delete":{"operationId":"deleteListById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete a list from the Marketing Automation system","tags":["marketing"]},"get":{"operationId":"getListById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve a list associated with a given ID from your Marketing Automation system. Specifying a list ID that is not associated with any list will result in an error response.","tags":["marketing"]},"patch":{"operationId":"updateListById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"in":"path","name":"id","required":true,"type":"string"},{"description":"The list object to be updated.
With the exception of the 'id' field, the required fields ","in":"body","name":"list","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update a list in the Marketing Automation system with the desired fields and upload a CSV file to populate your list.","tags":["marketing"]}},"/lists/{listId}/contacts":{"get":{"operationId":"getListsContacts","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for contacts last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all contacts are returned in a paginated fashion.","in":"query","name":"where","required":false,"type":"string"},{"description":"The page size for pagination, which defaults to 200 if not supplied","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"Specify if deleted contacts should be included in the search.","in":"query","name":"includeDeleted","required":false,"type":"boolean"},{"description":"A list ID to find contacts from.","in":"path","name":"listId","required":true,"type":"string"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/Contact"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Find contacts in a given list in the Marketing Automation system, using the provided CEQL search expression. The search expression in CEQL is the WHERE clause in a typical SQL query, but without the WHERE keyword. For example, to search for all contacts whose name contains the word 'data', the search expression parameter will be where=name like '%data%'. If a search expression is not provided, then the first 200 records will be returned.

If a value of true is specified for the includeDeleted flag, then any soft-deleted records will also be considered in the searched records.","tags":["marketing"]},"post":{"operationId":"createListContact","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the list to create a contact in.","in":"path","name":"listId","required":true,"type":"string"},{"description":"The contact object to be created.
","in":"body","name":"contacts","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Create a new contact in a given list in the Marketing Automation service. Contact creation will flow through Cloud Elements to your Marketing Automation service.","tags":["marketing"]}},"/lists/{listId}/contacts/{id}":{"delete":{"operationId":"deleteListsContactById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"A list ID to retrieve the contact from","in":"path","name":"listId","required":true,"type":"string"},{"description":"The ID of the contact to delete in the Marketing Automation system.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete a contact associated with a given ID from your Marketing Automation system. Specifying a contact associated with a given ID that does not exist will result in an error message.","tags":["marketing"]},"get":{"operationId":"getListsContactById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the list where the contact exists","in":"path","name":"listId","required":true,"type":"string"},{"description":"The ID of the contact to retrieve from the Marketing Automation system.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve a contact associated with a given ID from a given list from your Marketing Automation system. Specifying a contact or list associated with a given ID that does not exist will result in an error response.","tags":["marketing"]},"patch":{"operationId":"updateListsContactById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the list to retrieve the contact from","in":"path","name":"listId","required":true,"type":"string"},{"description":"The ID of the contact to update in the Marketing Automation system.","in":"path","name":"id","required":true,"type":"string"},{"description":"The contact object, with those fields that are to be updated.","in":"body","name":"contact","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update a contact in the given list associated with the given ID in the Marketing Automation system. The update API uses the PATCH HTTP verb, so only those fields provided in the contact object will be updated, and those fields not provided will be left alone.","tags":["marketing"]}},"/lookups/{fieldName}":{"get":{"operationId":"getLookupByFieldName","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The field name/path to get possible values for.","in":"path","name":"fieldName","required":true,"type":"string"},{"description":"The page size for pagination, which defaults to 200 if not supplied","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve possible values for a selection field in the HumanCapital system.","tags":["humancapital"]}},"/media/shortcode/{shortcode}":{"get":{"operationId":"getMediaShortcodeByShortcode","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The shortcode","in":"string","name":"shortcode","required":true,"type":"path"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve a media object by it's shortlink URL shortcode. An example shortlink is http://instagram.com/p/D/ where D would be the corresponding shortcode","tags":["social"]}},"/media/{mediaId}":{"get":{"operationId":"getMediaByMediaId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The media ID","in":"string","name":"mediaId","required":true,"type":"path"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve a media object","tags":["social"]}},"/messages":{"post":{"consumes":["application/json"],"operationId":"createMessage","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"Information about the message to be sent","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Send a new outgoing message using the messaging service provider. A valid User Secret and Element Token are required in the HTTP request.","tags":["messaging"]}},"/messages/{id}":{"get":{"operationId":"getMessageById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the message to get details for","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve the details for a given sent message associated with an ID from the messaging service. A valid User Secret and Element Token are required in the HTTP request.","tags":["messaging"]}},"/metrics/api":{"get":{"operationId":"getMetricsApi","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The customer IDs to search. If provided, all accounts within the customer record will be included.","in":"query","name":"customerIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"},{"description":"The organization IDs to search. If provided, all accounts within the organization will be included.","in":"query","name":"orgIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"},{"description":"The account IDs to search.","in":"query","name":"accountIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"},{"description":"Start time in ISO 8601 format, e.g. '2014-04-14T00:00:00-04:00'. An unspecified time zone defaults to UTC. Defaults to 7 days before end date.","in":"query","name":"from","required":false,"type":"string"},{"description":"End time in ISO 8601 format, e.g. '2014-04-14T00:00:00-04:00'. An unspecified time zone defaults to UTC.","in":"query","name":"to","required":false,"type":"string"},{"description":"Number of records per page, defaults to 10. The max is 1,000.","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","name":"nextPage","type":"string","required":false,"in":"query"},{"description":"The aggregation level. Aggregation of 'org' will roll up the metrics for all accounts under the organization. Aggregation of 'account' will roll up the metrics for each account. The default aggregation is 'account'.","name":"agg","type":"string","required":false,"in":"query","enum":["account","org"]},{"description":"The time interval on which to split the metrics. If not provided, a reasonable default value will be used. If the requested interval would result in too many returned intervals, an error will be returned instead.","name":"interval","type":"string","required":false,"in":"query","enum":["second","minute","hour","day","week","month","quarter","year"]},{"description":"Whether the response should include intervals that have no traffic. If set to true, each interval during the requested time period will be returned, regardless if there was traffic during that interval or not. The default is false.","name":"emptyIntervals","type":"boolean","required":false,"in":"query"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/ApiMetrics"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve the API metrics for the accounts provided. Any customer or organization IDs provided will be used to identify accounts within those entities.","tags":["metrics"]}},"/metrics/bulk-jobs":{"get":{"operationId":"getMetricsBulkJobs","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The customer IDs to search. If provided, all accounts within the customer record will be included.","in":"query","name":"customerIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"},{"description":"The organization IDs to search. If provided, all accounts within the organization will be included.","in":"query","name":"orgIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"},{"description":"The account IDs to search.","in":"query","name":"accountIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"},{"description":"Start time in ISO 8601 format, e.g. '2014-04-14T00:00:00-04:00'. An unspecified time zone defaults to UTC. Defaults to 7 days before end date.","in":"query","name":"from","required":false,"type":"string"},{"description":"End time in ISO 8601 format, e.g. '2014-04-14T00:00:00-04:00'. An unspecified time zone defaults to UTC.","in":"query","name":"to","required":false,"type":"string"},{"description":"Number of records per page, defaults to 10. The max is 1,000.","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","name":"nextPage","type":"string","required":false,"in":"query"},{"description":"The aggregation level. Aggregation of 'org' will roll up the metrics for all accounts under the organization. Aggregation of 'account' will roll up the metrics for each account. The default aggregation is 'account'.","name":"agg","type":"string","required":false,"in":"query","enum":["account","org"]},{"description":"The time interval on which to split the metrics. If not provided, a reasonable default value will be used. If the requested interval would result in too many returned intervals, an error will be returned instead.","name":"interval","type":"string","required":false,"in":"query","enum":["second","minute","hour","day","week","month","quarter","year"]},{"description":"Whether the response should include intervals that have no traffic. If set to true, each interval during the requested time period will be returned, regardless if there was traffic during that interval or not. The default is false.","name":"emptyIntervals","type":"boolean","required":false,"in":"query"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/BulkMetrics"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve the metrics of number of bulk jobs executed for the accounts provided. Any customer or organization IDs provided will be used to identify accounts within those entities.","tags":["metrics"]}},"/metrics/element-instances-created":{"get":{"operationId":"getMetricsElementInstancesCreated","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The customer IDs to search. If provided, all accounts within the customer record will be included.","in":"query","name":"customerIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"},{"description":"The organization IDs to search. If provided, all accounts within the organization will be included.","in":"query","name":"orgIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"},{"description":"The account IDs to search.","in":"query","name":"accountIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"},{"description":"Start time in ISO 8601 format, e.g. '2014-04-14T00:00:00-04:00'. An unspecified time zone defaults to UTC. Defaults to 7 days before end date.","in":"query","name":"from","required":false,"type":"string"},{"description":"End time in ISO 8601 format, e.g. '2014-04-14T00:00:00-04:00'. An unspecified time zone defaults to UTC.","in":"query","name":"to","required":false,"type":"string"},{"description":"Number of records per page, defaults to 10. The max is 1,000.","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","name":"nextPage","type":"string","required":false,"in":"query"},{"description":"The aggregation level. Aggregation of 'org' will roll up the metrics for all accounts under the organization. Aggregation of 'account' will roll up the metrics for each account. The default aggregation is 'account'.","name":"agg","type":"string","required":false,"in":"query","enum":["account","org"]},{"description":"The time interval on which to split the metrics. If not provided, a reasonable default value will be used. If the requested interval would result in too many returned intervals, an error will be returned instead.","name":"interval","type":"string","required":false,"in":"query","enum":["second","minute","hour","day","week","month","quarter","year"]},{"description":"Whether the response should include intervals that have no traffic. If set to true, each interval during the requested time period will be returned, regardless if there was traffic during that interval or not. The default is false.","name":"emptyIntervals","type":"boolean","required":false,"in":"query"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/ElementInstancesCreatedMetrics"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve the element instance creation API metrics for the accounts provided, split up by element key. Any customer or organization IDs provided will be used to identify accounts within those entities.","tags":["metrics"]}},"/metrics/elements-created":{"get":{"operationId":"getMetricsElementsCreated","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The customer IDs to search. If provided, all accounts within the customer record will be included.","in":"query","name":"customerIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"},{"description":"The organization IDs to search. If provided, all accounts within the organization will be included.","in":"query","name":"orgIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"},{"description":"The account IDs to search.","in":"query","name":"accountIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"},{"description":"Start time in ISO 8601 format, e.g. '2014-04-14T00:00:00-04:00'. An unspecified time zone defaults to UTC. Defaults to 7 days before end date.","in":"query","name":"from","required":false,"type":"string"},{"description":"End time in ISO 8601 format, e.g. '2014-04-14T00:00:00-04:00'. An unspecified time zone defaults to UTC.","in":"query","name":"to","required":false,"type":"string"},{"description":"Number of records per page, defaults to 10. The max is 1,000.","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","name":"nextPage","type":"string","required":false,"in":"query"},{"description":"The aggregation level. Aggregation of 'org' will roll up the metrics for all accounts under the organization. Aggregation of 'account' will roll up the metrics for each account. The default aggregation is 'account'.","name":"agg","type":"string","required":false,"in":"query","enum":["account","org"]},{"description":"The time interval on which to split the metrics. If not provided, a reasonable default value will be used. If the requested interval would result in too many returned intervals, an error will be returned instead.","name":"interval","type":"string","required":false,"in":"query","enum":["second","minute","hour","day","week","month","quarter","year"]},{"description":"Whether the response should include intervals that have no traffic. If set to true, each interval during the requested time period will be returned, regardless if there was traffic during that interval or not. The default is false.","name":"emptyIntervals","type":"boolean","required":false,"in":"query"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/Metrics"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve the metrics of number of custom elements created for the accounts provided. Any customer or organization IDs provided will be used to identify accounts within those entities.","tags":["metrics"]}},"/metrics/events":{"get":{"operationId":"getMetricsEvents","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The customer IDs to search. If provided, all accounts within the customer record will be included.","in":"query","name":"customerIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"},{"description":"The organization IDs to search. If provided, all accounts within the organization will be included.","in":"query","name":"orgIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"},{"description":"The account IDs to search.","in":"query","name":"accountIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"},{"description":"Start time in ISO 8601 format, e.g. '2014-04-14T00:00:00-04:00'. An unspecified time zone defaults to UTC. Defaults to 7 days before end date.","in":"query","name":"from","required":false,"type":"string"},{"description":"End time in ISO 8601 format, e.g. '2014-04-14T00:00:00-04:00'. An unspecified time zone defaults to UTC.","in":"query","name":"to","required":false,"type":"string"},{"description":"Number of records per page, defaults to 10. The max is 1,000.","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","name":"nextPage","type":"string","required":false,"in":"query"},{"description":"The aggregation level. Aggregation of 'org' will roll up the metrics for all accounts under the organization. Aggregation of 'account' will roll up the metrics for each account. The default aggregation is 'account'.","name":"agg","type":"string","required":false,"in":"query","enum":["account","org"]},{"description":"The time interval on which to split the metrics. If not provided, a reasonable default value will be used. If the requested interval would result in too many returned intervals, an error will be returned instead.","name":"interval","type":"string","required":false,"in":"query","enum":["second","minute","hour","day","week","month","quarter","year"]},{"description":"Whether the response should include intervals that have no traffic. If set to true, each interval during the requested time period will be returned, regardless if there was traffic during that interval or not. The default is false.","name":"emptyIntervals","type":"boolean","required":false,"in":"query"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/Metrics"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve the metrics of number of events received for the accounts provided. Any customer or organization IDs provided will be used to identify accounts within those entities.","tags":["metrics"]}},"/metrics/formula-executions":{"get":{"operationId":"getMetricsFormulaExecutions","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The customer IDs to search. If provided, all accounts within the customer record will be included.","in":"query","name":"customerIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"},{"description":"The organization IDs to search. If provided, all accounts within the organization will be included.","in":"query","name":"orgIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"},{"description":"The account IDs to search.","in":"query","name":"accountIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"},{"description":"Start time in ISO 8601 format, e.g. '2014-04-14T00:00:00-04:00'. An unspecified time zone defaults to UTC. Defaults to 7 days before end date.","in":"query","name":"from","required":false,"type":"string"},{"description":"End time in ISO 8601 format, e.g. '2014-04-14T00:00:00-04:00'. An unspecified time zone defaults to UTC.","in":"query","name":"to","required":false,"type":"string"},{"description":"Number of records per page, defaults to 10. The max is 1,000.","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","name":"nextPage","type":"string","required":false,"in":"query"},{"description":"The aggregation level. Aggregation of 'org' will roll up the metrics for all accounts under the organization. Aggregation of 'account' will roll up the metrics for each account. The default aggregation is 'account'.","name":"agg","type":"string","required":false,"in":"query","enum":["account","org"]},{"description":"The time interval on which to split the metrics. If not provided, a reasonable default value will be used. If the requested interval would result in too many returned intervals, an error will be returned instead.","name":"interval","type":"string","required":false,"in":"query","enum":["second","minute","hour","day","week","month","quarter","year"]},{"description":"Whether the response should include intervals that have no traffic. If set to true, each interval during the requested time period will be returned, regardless if there was traffic during that interval or not. The default is false.","name":"emptyIntervals","type":"boolean","required":false,"in":"query"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/Metrics"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve the metrics of number of formulas executions for the accounts provided. Any customer or organization IDs provided will be used to identify accounts within those entities.","tags":["metrics"]}},"/metrics/formulas-created":{"get":{"operationId":"getMetricsFormulasCreated","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The customer IDs to search. If provided, all accounts within the customer record will be included.","in":"query","name":"customerIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"},{"description":"The organization IDs to search. If provided, all accounts within the organization will be included.","in":"query","name":"orgIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"},{"description":"The account IDs to search.","in":"query","name":"accountIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"},{"description":"Start time in ISO 8601 format, e.g. '2014-04-14T00:00:00-04:00'. An unspecified time zone defaults to UTC. Defaults to 7 days before end date.","in":"query","name":"from","required":false,"type":"string"},{"description":"End time in ISO 8601 format, e.g. '2014-04-14T00:00:00-04:00'. An unspecified time zone defaults to UTC.","in":"query","name":"to","required":false,"type":"string"},{"description":"Number of records per page, defaults to 10. The max is 1,000.","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","name":"nextPage","type":"string","required":false,"in":"query"},{"description":"The aggregation level. Aggregation of 'org' will roll up the metrics for all accounts under the organization. Aggregation of 'account' will roll up the metrics for each account. The default aggregation is 'account'.","name":"agg","type":"string","required":false,"in":"query","enum":["account","org"]},{"description":"The time interval on which to split the metrics. If not provided, a reasonable default value will be used. If the requested interval would result in too many returned intervals, an error will be returned instead.","name":"interval","type":"string","required":false,"in":"query","enum":["second","minute","hour","day","week","month","quarter","year"]},{"description":"Whether the response should include intervals that have no traffic. If set to true, each interval during the requested time period will be returned, regardless if there was traffic during that interval or not. The default is false.","name":"emptyIntervals","type":"boolean","required":false,"in":"query"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/Metrics"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve the metrics of number of formulas created for the accounts provided. Any customer or organization IDs provided will be used to identify accounts within those entities.","tags":["metrics"]}},"/metrics/hub-api":{"get":{"operationId":"getMetricsHubApi","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The customer IDs to search. If provided, all accounts within the customer record will be included.","in":"query","name":"customerIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"},{"description":"The organization IDs to search. If provided, all accounts within the organization will be included.","in":"query","name":"orgIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"},{"description":"The account IDs to search.","in":"query","name":"accountIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"},{"description":"Start time in ISO 8601 format, e.g. '2014-04-14T00:00:00-04:00'. An unspecified time zone defaults to UTC. Defaults to 7 days before end date.","in":"query","name":"from","required":false,"type":"string"},{"description":"End time in ISO 8601 format, e.g. '2014-04-14T00:00:00-04:00'. An unspecified time zone defaults to UTC.","in":"query","name":"to","required":false,"type":"string"},{"description":"Number of records per page, defaults to 10. The max is 1,000.","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","name":"nextPage","type":"string","required":false,"in":"query"},{"description":"The aggregation level. Aggregation of 'org' will roll up the metrics for all accounts under the organization. Aggregation of 'account' will roll up the metrics for each account. The default aggregation is 'account'.","name":"agg","type":"string","required":false,"in":"query","enum":["account","org"]},{"description":"The time interval on which to split the metrics. If not provided, a reasonable default value will be used. If the requested interval would result in too many returned intervals, an error will be returned instead.","name":"interval","type":"string","required":false,"in":"query","enum":["second","minute","hour","day","week","month","quarter","year"]},{"description":"Whether the response should include intervals that have no traffic. If set to true, each interval during the requested time period will be returned, regardless if there was traffic during that interval or not. The default is false.","name":"emptyIntervals","type":"boolean","required":false,"in":"query"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/HubMetrics"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve the API metrics for the accounts provided, split up by hub. Any customer or organization IDs provided will be used to identify accounts within those entities.","tags":["metrics"]}},"/metrics/hubs-created":{"get":{"operationId":"getMetricsHubsCreated","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The customer IDs to search. If provided, all accounts within the customer record will be included.","in":"query","name":"customerIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"},{"description":"The organization IDs to search. If provided, all accounts within the organization will be included.","in":"query","name":"orgIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"},{"description":"The account IDs to search.","in":"query","name":"accountIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"},{"description":"Start time in ISO 8601 format, e.g. '2014-04-14T00:00:00-04:00'. An unspecified time zone defaults to UTC. Defaults to 7 days before end date.","in":"query","name":"from","required":false,"type":"string"},{"description":"End time in ISO 8601 format, e.g. '2014-04-14T00:00:00-04:00'. An unspecified time zone defaults to UTC.","in":"query","name":"to","required":false,"type":"string"},{"description":"Number of records per page, defaults to 10. The max is 1,000.","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","name":"nextPage","type":"string","required":false,"in":"query"},{"description":"The aggregation level. Aggregation of 'org' will roll up the metrics for all accounts under the organization. Aggregation of 'account' will roll up the metrics for each account. The default aggregation is 'account'.","name":"agg","type":"string","required":false,"in":"query","enum":["account","org"]},{"description":"The time interval on which to split the metrics. If not provided, a reasonable default value will be used. If the requested interval would result in too many returned intervals, an error will be returned instead.","name":"interval","type":"string","required":false,"in":"query","enum":["second","minute","hour","day","week","month","quarter","year"]},{"description":"Whether the response should include intervals that have no traffic. If set to true, each interval during the requested time period will be returned, regardless if there was traffic during that interval or not. The default is false.","name":"emptyIntervals","type":"boolean","required":false,"in":"query"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/HubMetrics"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve the hubs created metrics for the accounts provided, split up by hub. Any customer or organization IDs provided will be used to identify accounts within those entities.","tags":["metrics"]}},"/metrics/vdrs-created":{"get":{"operationId":"getMetricsVdrsCreated","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The customer IDs to search. If provided, all accounts within the customer record will be included.","in":"query","name":"customerIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"},{"description":"The organization IDs to search. If provided, all accounts within the organization will be included.","in":"query","name":"orgIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"},{"description":"The account IDs to search.","in":"query","name":"accountIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"},{"description":"Start time in ISO 8601 format, e.g. '2014-04-14T00:00:00-04:00'. An unspecified time zone defaults to UTC. Defaults to 7 days before end date.","in":"query","name":"from","required":false,"type":"string"},{"description":"End time in ISO 8601 format, e.g. '2014-04-14T00:00:00-04:00'. An unspecified time zone defaults to UTC.","in":"query","name":"to","required":false,"type":"string"},{"description":"Number of records per page, defaults to 10. The max is 1,000.","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","name":"nextPage","type":"string","required":false,"in":"query"},{"description":"The aggregation level. Aggregation of 'org' will roll up the metrics for all accounts under the organization. Aggregation of 'account' will roll up the metrics for each account. The default aggregation is 'account'.","name":"agg","type":"string","required":false,"in":"query","enum":["account","org"]},{"description":"The time interval on which to split the metrics. If not provided, a reasonable default value will be used. If the requested interval would result in too many returned intervals, an error will be returned instead.","name":"interval","type":"string","required":false,"in":"query","enum":["second","minute","hour","day","week","month","quarter","year"]},{"description":"Whether the response should include intervals that have no traffic. If set to true, each interval during the requested time period will be returned, regardless if there was traffic during that interval or not. The default is false.","name":"emptyIntervals","type":"boolean","required":false,"in":"query"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/Metrics"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve the metrics of number of VDRs created for the accounts provided. Any customer or organization IDs provided will be used to identify accounts within those entities.","tags":["metrics"]}},"/metrics/vdrs-invoked":{"get":{"operationId":"getMetricsVdrsInvoked","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The customer IDs to search. If provided, all accounts within the customer record will be included.","in":"query","name":"customerIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"},{"description":"The organization IDs to search. If provided, all accounts within the organization will be included.","in":"query","name":"orgIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"},{"description":"The account IDs to search.","in":"query","name":"accountIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"},{"description":"Start time in ISO 8601 format, e.g. '2014-04-14T00:00:00-04:00'. An unspecified time zone defaults to UTC. Defaults to 7 days before end date.","in":"query","name":"from","required":false,"type":"string"},{"description":"End time in ISO 8601 format, e.g. '2014-04-14T00:00:00-04:00'. An unspecified time zone defaults to UTC.","in":"query","name":"to","required":false,"type":"string"},{"description":"Number of records per page, defaults to 10. The max is 1,000.","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","name":"nextPage","type":"string","required":false,"in":"query"},{"description":"The aggregation level. Aggregation of 'org' will roll up the metrics for all accounts under the organization. Aggregation of 'account' will roll up the metrics for each account. The default aggregation is 'account'.","name":"agg","type":"string","required":false,"in":"query","enum":["account","org"]},{"description":"The time interval on which to split the metrics. If not provided, a reasonable default value will be used. If the requested interval would result in too many returned intervals, an error will be returned instead.","name":"interval","type":"string","required":false,"in":"query","enum":["second","minute","hour","day","week","month","quarter","year"]},{"description":"Whether the response should include intervals that have no traffic. If set to true, each interval during the requested time period will be returned, regardless if there was traffic during that interval or not. The default is false.","name":"emptyIntervals","type":"boolean","required":false,"in":"query"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/Metrics"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve the metrics of number of calls using VDRs for the accounts provided. Any customer or organization IDs provided will be used to identify accounts within those entities.","tags":["metrics"]}},"/objects":{"get":{"operationId":"getObjects","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Get a list of all the available objects.","tags":["marketing"]}},"/objects/{objectName}/metadata":{"get":{"operationId":"getObjectsObjectNameMetadata","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Get a list of all the field for an object.","tags":["marketing"]}},"/opportunities":{"get":{"operationId":"getOpportunities","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The CEQL search expression","in":"query","name":"where","required":false,"type":"string"},{"description":"The page size. Defaults to 200 if not provided. Maximum of 5000","in":"query","name":"pageSize","required":false,"type":"string","format":"int64"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/opportunities"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Search for opportunities","tags":["erp"]},"post":{"operationId":"createOpportunity","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The opportunity","in":"body","name":"opportunity","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Create an opportunity","tags":["erp"]}},"/opportunities/{id}":{"delete":{"operationId":"deleteOpportunityById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the opportunity to delete from the CRM system.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete an opportunity associated with a given ID from the CRM system. Specifying an opportunity associated with a given ID that does not exist will result in an error message.","tags":["crm"]},"get":{"operationId":"getOpportunityById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the opportunity to retrieve from the CRM system.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve an opportunity associated with a given ID from the CRM system.Specifying an opportunity with a specified ID that does not exist will result in an error response.","tags":["crm"]},"patch":{"operationId":"updateOpportunityById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the opportunity to update in the CRM system.","in":"path","name":"id","required":true,"type":"string"},{"description":"The opportunity object, with those fields that are to be updated.","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update the opportunity associated with the given ID in the CRM system. The update API uses the PATCH HTTP verb, so only those fields provided in the opportunity object will be updated, and those fields not provided will be left alone.Updating an opportunity with a specified ID that does not exist will result in an error response.","tags":["crm"]}},"/opportunities/{opportunityId}":{"delete":{"operationId":"deleteOpportunityByOpportunityId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The opportunity ID","in":"path","name":"opportunityId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete an opportunity","tags":["erp"]},"get":{"operationId":"getOpportunityByOpportunityId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The opportunity ID","in":"path","name":"opportunityId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve an opportunity","tags":["erp"]},"patch":{"operationId":"updateOpportunityByOpportunityId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The opportunity ID","in":"path","name":"opportunityId","required":true,"type":"string"},{"description":"The opportunity","in":"body","name":"opportunity","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update an opportunity","tags":["erp"]}},"/orders":{"get":{"operationId":"getOrders","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for orders last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all orders are returned in a paginated fashion.","in":"query","name":"where","required":false,"type":"string"},{"description":"Specify if deleted orders should be included in the search.","in":"query","name":"includeDeleted","required":false,"type":"boolean"},{"description":"The number of results to fetch in a given page. When this parameter is omitted, a maximum of 200 results are returned.","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/Order"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Find orders in the eCommerce system, using the provided CEQL search expression. The search expression in CEQL is the WHERE clause in a typical SQL query, but without the WHERE keyword. For example, to search for all orders whose name contains the word 'data', the search expression parameter will be where=name like '%data%'. If a search expression is not provided, then the first 200 records will be returned.

If a value of true is specified for the includeDeleted flag, then any soft-deleted records will also be considered in the searched records.","tags":["ecommerce"]},"post":{"operationId":"createOrder","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The Order object to be created.
With the exception of the 'id' field, the required fields indicated in the 'Order' model are those required to create a new order.","in":"body","name":"order","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Create a new order in the eCommerce system. Order creation will flow through Cloud Elements to your eCommerce service. With the exception of the 'id' field, the required fields indicated in the 'Order' model are those required to create a new order.","tags":["ecommerce"]}},"/orders/{id}":{"delete":{"operationId":"deleteOrderById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the order to delete from the eCommerce system.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete an order associated with a given ID from your eCommerce system.\nSpecifying an order associated with a given ID that does not exist will result in an error message.","tags":["ecommerce"]},"get":{"operationId":"getOrderById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the order to retrieve from the eCommerce system.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve an order associated with a given ID from the eCommerce system.Specifying an order with a specified ID that does not exist will result in an error response.","tags":["ecommerce"]},"patch":{"operationId":"updateOrderById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the order to update in the eCommerce system.","in":"path","name":"id","required":true,"type":"string"},{"description":"The order object, with those fields that are to be updated.","in":"body","name":"order","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},{"description":"An action to perform on the order: cancel, reopen or close. If left blank then the order is updated but no action is taken.","in":"query","name":"action","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update an order associated with a given ID in the eCommerce system. The update API uses the PATCH HTTP verb, so only those fields provided in the order object will be updated, and those fields not provided will be left aloneUpdating an order with a specified ID that does not exist will result in an error response.","tags":["ecommerce"]}},"/orders/{id}/payments":{"post":{"operationId":"createOrderPayment","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the order to create a payment for from the eCommerce system.","in":"path","name":"id","required":true,"type":"string"},{"description":"The Payment object to be created.
With the exception of the 'id' field, the required fields indicated in the 'Payment' model are those required to create a new payment.","in":"body","name":"payment","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Create a new payment in an order the eCommerce system. Payment creation will flow through Cloud Elements to your eCommerce service. With the exception of the 'id' field, the required fields indicated in the 'Payment' model are those required to create a new payment.","tags":["ecommerce"]}},"/orders/{orderId}/payments":{"get":{"operationId":"getOrdersPayments","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the order to retrieve payments from in the eCommerce system.","in":"path","name":"orderId","required":true,"type":"string"},{"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for payments last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all payments are returned in a paginated fashion.","in":"query","name":"where","required":false,"type":"string"},{"description":"Specify if deleted payments should be included in the search.","in":"query","name":"includeDeleted","required":false,"type":"boolean"},{"description":"The number of results to fetch in a given page. When this parameter is omitted, a maximum of 200 results are returned.","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/Transaction"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Find payments in the eCommerce system, using the provided CEQL search expression. The search expression in CEQL is the WHERE clause in a typical SQL query, but without the WHERE keyword. For example, to search for all payments whose name contains the word 'data', the search expression parameter will be where=name like '%data%'. If a search expression is not provided, then the first 200 records will be returned.

If a value of true is specified for the includeDeleted flag, then any soft-deleted records will also be considered in the searched records.","tags":["ecommerce"]}},"/orders/{orderId}/payments/{paymentId}":{"get":{"operationId":"getOrdersPaymentByPaymentId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the order to retrieve the payment from in the eCommerce system.","in":"path","name":"orderId","required":true,"type":"string"},{"description":"The ID of the payment to retrieve the from the eCommerce system.","in":"path","name":"paymentId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve a payment associated with a given ID from the eCommerce system.Specifying a payment with a specified ID that does not exist will result in an error response.","tags":["ecommerce"]}},"/orders/{orderId}/refunds":{"get":{"operationId":"getOrdersRefunds","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the order to retrieve refunds from in the eCommerce system.","in":"path","name":"orderId","required":true,"type":"string"},{"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for payments last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all refunds are returned in a paginated fashion.","in":"query","name":"where","required":false,"type":"string"},{"description":"Specify if deleted refunds should be included in the search.","in":"query","name":"includeDeleted","required":false,"type":"boolean"},{"description":"The number of results to fetch in a given page. When this parameter is omitted, a maximum of 200 results are returned.","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/Transaction"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Find refunds in the eCommerce system, using the provided CEQL search expression. The search expression in CEQL is the WHERE clause in a typical SQL query, but without the WHERE keyword. For example, to search for all payments whose name contains the word 'data', the search expression parameter will be where=name like '%data%'. If a search expression is not provided, then the first 200 records will be returned.

If a value of true is specified for the includeDeleted flag, then any soft-deleted records will also be considered in the searched records.","tags":["ecommerce"]}},"/organizations":{"post":{"operationId":"createOrganization","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The organization to create.","in":"body","name":"organization","required":true,"schema":{"$ref":"#/definitions/Organization-POST"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Organization-GET"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Create a new organization within the user's customer. NOTE: This API requires the 'customer-admin' privilege.","tags":["organizations"]}},"/organizations/elements/{keyOrId}/transformations":{"delete":{"operationId":"deleteOrganizationsElementsTransformations","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key or ID","in":"path","name":"keyOrId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Delete the default transformation for an element within an organization. The key field denotes the element being referenced in the API call, i.e. dropbox.","tags":["organizations"]},"get":{"operationId":"getOrganizationsElementsTransformations","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key or ID","in":"path","name":"keyOrId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/TransformationLibrary"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve the default transformation for a specific element within an organization. The key field denotes the element being referenced in the API call, i.e. dropbox.","tags":["organizations"]}},"/organizations/elements/{keyOrId}/transformations/{objectName}":{"delete":{"operationId":"deleteOrganizationsElementsTransformationByObjectName","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key or ID","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Delete the default transformation for an object for a specific element within an organization. The key field denotes the element being referenced in the API call, i.e. dropbox.","tags":["organizations"]},"get":{"operationId":"getOrganizationsElementsTransformationByObjectName","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key or ID","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Transformation"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve the default transformation for an object for a specific element within an organization. The key field denotes the element being referenced in the API call, i.e. dropbox.","tags":["organizations"]},"post":{"operationId":"createOrganizationElementTransformationByObjectName","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key or ID","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The transformation","in":"body","name":"transformation","required":true,"schema":{"$ref":"#/definitions/Transformation"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Transformation"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Create a default transformation for a specific object for all elements with the given key, within an organization. The key field denotes the element being referenced in the API call, i.e. dropbox.","tags":["organizations"]},"put":{"operationId":"replaceOrganizationsElementsTransformationByObjectName","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The element key or ID","in":"path","name":"keyOrId","required":true,"type":"string"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The transformation","in":"body","name":"transformation","required":true,"schema":{"$ref":"#/definitions/Transformation"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Transformation"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Update the default transformation for an object for a specific element element within an organization. The key field denotes the element being referenced in the API call, i.e. dropbox.","tags":["organizations"]}},"/organizations/me":{"get":{"operationId":"getOrganizationsMe","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Organization"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve the user's organization","tags":["organizations"]},"put":{"operationId":"replaceOrganizationsMe","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The organization metadata to update. The only fields that can be updated are 'name' and 'externalId'.","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Organization"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Organization-GET"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Update the user's organization metadata","tags":["organizations"]}},"/organizations/objects/definitions":{"delete":{"operationId":"deleteOrganizationsObjectsDefinitions","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Delete all object definitions within an organization.","tags":["organizations"]},"get":{"operationId":"getOrganizationsObjectsDefinitions","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Dictionary"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve all of the object definitions within an organization.","tags":["organizations"]},"post":{"operationId":"createOrganizationObjectDefinition","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The object definitions to create","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Dictionary"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Dictionary"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Create multiple object definitions within an organization. The definitions allow you to define what an object looks like within an organization.","tags":["organizations"]}},"/organizations/objects/{objectName}/definitions":{"delete":{"operationId":"deleteOrganizationsObjectsObjectNameDefinitions","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Delete an object definition associated with a specific objectName within an organization. Specifying an object definition associated with a given objectName that does not exist will result in an error response.","tags":["organizations"]},"get":{"operationId":"getOrganizationsObjectsObjectNameDefinitions","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Definition"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve a specific object definition associated with an objectName within an organization.","tags":["organizations"]},"post":{"operationId":"createOrganizationObjectObjectNameDefinition","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The object definition","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Definition"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Definition"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Create a new object definition associated with an objectName within an organization. The definitions allow you to define what an object looks like within an organization.","tags":["organizations"]},"put":{"operationId":"replaceOrganizationsObjectsObjectNameDefinitions","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The object definition","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Definition"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Definition"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Update a specific object's definition associated with a specific objectName within an organization. Specifying an object definition associated with a given objectName that does not exist will result in an error response.","tags":["organizations"]}},"/organizations/users":{"get":{"operationId":"getOrganizationsUsers","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The CEQL search expression or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for users created on or after 'Jan 15, 2014', the search expression will be where=createdDate >= '2014-01-15'. When this parameter is omitted, all accounts are returned in a paginated fashion.","in":"query","name":"where","required":false,"type":"string"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"},{"description":"The page size. Defaults to 200 if not provided. Maximum of 200","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"Whether to return inactive users in the response. Deleted users will not be returned even if this is set to true. The default is false","in":"query","name":"includeInactive","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/User"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Find users within your default organizational account. The CEQL search expression or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for users containing the name 'greg', the search expression will be where name=‘greg’. When this parameter is omitted, all accounts are returned in a paginated fashion.","tags":["organizations"]},"post":{"operationId":"createOrganizationUser","deprecated":true,"description":"This API has been deprecated please refer to the 'OAuth and User Mgmt' APIs","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The user to create

The required fields are:


Upon success, the created object will be returned.","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/User"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/User"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Create a user under the default organization account","tags":["organizations"]}},"/organizations/users/{id}":{"get":{"operationId":"getOrganizationsUserById","deprecated":true,"description":"This API has been deprecated please refer to the 'OAuth and User Mgmt' APIs","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The email address or numeric ID of the user (emailOrId)","in":"path","name":"id","required":true,"type":"string"},{"description":"The user's password. If the password is correct, the user secret of this user will also be returned in the response body.","in":"header","name":"Elements-User-Password","required":false,"type":"string"},{"description":"Whether to consider inactive users in the request. Deleted users will not be returned even if this is set to true. The default is false","in":"query","name":"includeInactive","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/User"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve a user associated with an email or ID within the default organization. Specifying a user associated with a given emailOrId that does not exist will result in an error response.","tags":["organizations"]},"delete":{"operationId":"deleteOrganizationsUserById","deprecated":true,"description":"This API has been deprecated please refer to the 'OAuth and User Mgmt' APIs","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the user","format":"int64","in":"path","name":"id","required":true,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Delete a user associated with an ID within your organization. WARNING: This action will irreversibly delete all jobs, and formula and element instances associated with the user.","tags":["organizations"]},"patch":{"operationId":"updateOrganizationsUserById","deprecated":true,"description":"This API has been deprecated please refer to the 'OAuth and User Mgmt' APIs","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the user","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The updated user information","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/User"}},{"description":"Only applicable when deactivating a user. Flag to indicate whether the status change is permanent. WARNING: If permanent is true, all jobs, and formula and element instances for the user will be irreversibly deleted.","in":"query","name":"permanent","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/User"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Update a user associated with an ID within your organization. WARNING: If updating the 'active' field to false, all of the scheduled jobs for the user will be deleted.","tags":["organizations"]}},"/organizations/{id}":{"put":{"operationId":"replaceOrganizationById","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the organization","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The organization metadata to update. The only fields that can be updated are 'name' and 'externalId'.","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Organization"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Organization-GET"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Update an organization metadata NOTE: This API requires the 'customer-admin' privilege.","tags":["organizations"]}},"/organizations/{id}/accounts":{"post":{"operationId":"createOrganizationAccount","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the organization","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The account to create.","in":"body","name":"account","required":true,"schema":{"$ref":"#/definitions/Account-POST"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Account-GET"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Create a new account within an organization. NOTE: Only a user with the 'org-admin' privilege within the organization, or the 'customer-admin' privilege within the customer is able to use this API.","tags":["organizations"]},"get":{"operationId":"getOrganizationsAccounts","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the organization","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"},{"description":"The page size. Defaults to 200 if not provided. Maximum of 200","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The CEQL search expression or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for accounts with a specific externalId, the search expression will be where=externalId='my-ext-id'. When this parameter is omitted, all accounts for the organization are returned in a paginated fashion","in":"query","name":"where","required":false,"type":"string"},{"description":"Whether to include inactive (deleted) organizations in the results. The default is false","in":"query","name":"includeInactive","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"type":"array","items":{"$ref":"#/definitions/Account-GET"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve all the accounts within an organization. NOTE: Only a user with the 'org-admin' privilege within the organization, or the 'customer-admin' privilege within the customer is able to use this API.","tags":["organizations"]}},"/organizations/{id}/accounts/{accountId}":{"get":{"operationId":"getOrganizationsAccountByAccountId","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the organization","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"The ID of the account","in":"path","name":"accountId","required":true,"type":"integer"},{"description":"Whether to consider inactive (deleted) accounts in the request. The default is false","in":"query","name":"includeInactive","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Account-GET"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve an account within an organization NOTE: Only a user with the 'org-admin' privilege within the organization, or the 'customer-admin' privilege within the customer is able to use this API.","tags":["organizations"]}},"/organizations/{id}/status":{"put":{"operationId":"replaceOrganizationsStatus","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the organization","format":"int64","in":"path","name":"id","required":true,"type":"integer"},{"description":"Update the organization status.","in":"body","name":"status","required":true,"schema":{"$ref":"#/definitions/OrganizationStatus-PUT"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Account-GET"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Enables and disables organizations. NOTE: Only a user with the 'intelligence user' privilege within the organization, or the 'customer-admin' privilege within the customer is able to use this API.","tags":["organizations"]}},"/payment-methods":{"get":{"operationId":"getPaymentMethods","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for accounts last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all accounts are returned ","in":"query","name":"where","required":false,"type":"string"},{"description":"The start page for pagination, which defaults to 1 if not supplied","format":"int64","in":"query","name":"start","required":false,"type":"integer"},{"description":"The page size for pagination, which defaults to 200 if not supplied","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/PaymentMethod"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Find Payment Methods in the Finance System, using the provided CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for payments last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all payments are returned.","tags":["finance"]}},"/payment-methods/{id}":{"get":{"operationId":"getPaymentMethodById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The Id of the payment method to retrieve from the finance system.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve a defined Payment Method associated with a given ID from the Finance system. Specifying a payment method with an associated ID that does not exist will result in an error response.","tags":["finance"]}},"/payment-methods/{paymentMethodId}":{"get":{"operationId":"getPaymentMethodByPaymentMethodId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The payment method ID","in":"path","name":"paymentMethodId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve a payment method","tags":["erp"]}},"/payments":{"get":{"operationId":"getPayments","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for accounts last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all payments are returned ","in":"query","name":"where","required":false,"type":"string"},{"description":"The page size for pagination, which defaults to 200 if not supplied","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/Payment"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Find Payments in the Finance System, using the provided CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for payments last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all payments are returned.","tags":["finance"]},"post":{"operationId":"createPayment","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The Payment object to be created.
With the exception of the 'id' field, the required fields indicated in the 'Payment' model are those required to create a new payment","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Create or initiate a payment in the Finance system. Payment creation/initiation will flow through Cloud Elements to the Finance Service.","tags":["finance"]}},"/payments/{id}":{"delete":{"operationId":"deletePaymentById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the payment to delete in the Finance system.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete a payment associated with a given ID from the Finance system. Specifying a payment associated with a given ID that does not exist will result in an error message.","tags":["finance"]},"get":{"operationId":"getPaymentById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The Id of the payment to retrieve from the finance system.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve a defined Payment associated with a given ID from the Finance system. Specifying a payment with an associated ID that does not exist will result in an error response.","tags":["finance"]},"patch":{"operationId":"updatePaymentById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the payment to update in the Finance system.","in":"path","name":"id","required":true,"type":"string"},{"description":"The payment object, with those fields that are to be updated.","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update a Payment given a set of partial payment attributes associated with a given ID in the Finance system. The update API uses the PATCH HTTP verb, so only those fields provided in the payment object will be updated, and those fields not provided will be left alone. Updating a payment with a specified ID that does not exist will result in an error response.","tags":["finance"]}},"/payments/{paymentId}":{"delete":{"operationId":"deletePaymentByPaymentId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The payment ID","in":"path","name":"paymentId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete a payment","tags":["erp"]},"get":{"operationId":"getPaymentByPaymentId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The payment ID","in":"path","name":"paymentId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve a payment","tags":["erp"]},"patch":{"operationId":"updatePaymentByPaymentId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The payment ID","in":"path","name":"paymentId","required":true,"type":"string"},{"description":"The payment","in":"body","name":"payment","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update a payment","tags":["erp"]}},"/ping":{"get":{"operationId":"getPing","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Ping the Element to confirm that the Hub Element has a heartbeat. If the Element does not have a heartbeat, an error message will be returned.","tags":["ecommerce"]}},"/priorities":{"get":{"operationId":"getPriorities","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for incident types last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all priorities are returned in a paginated fashion.","in":"query","name":"where","required":false,"type":"string"},{"description":"Specify if deleted incidents should be included in the search.","in":"query","name":"includeDeleted","required":false,"type":"boolean"},{"description":"The number of results to return per page","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/Priority"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Search for priority or priorities in the help desk system, using the provided CEQL search expression. The search expression in CEQL is the WHERE clause in a typical SQL query, but without the WHERE keyword. For example, to search for all priorities whose type contains the word 'high', the search expression parameter will be where=type='%high%'. Performing a search without these parameters will not return any results.

If a value of true is specified for the includeDeleted flag, then any soft-deleted records will also be considered in the searched records.","tags":["helpdesk"]},"post":{"operationId":"createPriority","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The priority to create","in":"body","name":"priority","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Create a new priority in the help desk system. Priority creation will flow through Cloud Elements to the help desk service. If a Priority already exists will return an error message.","tags":["helpdesk"]}},"/priorities/{id}":{"delete":{"operationId":"deletePriorityById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the priority","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete priority field from the help desk system.If the priority does not exist will result in an error message.","tags":["helpdesk"]},"get":{"operationId":"getPriorityById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the priority","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve priority field from the help desk systemPriority field that does not exist will result in an error response.","tags":["helpdesk"]},"patch":{"operationId":"updatePriorityById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the priority","in":"path","name":"id","required":true,"type":"string"},{"description":"The priority, containing only the fields to update","in":"body","name":"priority","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update priority in the help desk system. The update API uses the PATCH HTTP verb, so only those fields provided in the priority object will be updated, and those fields not provided will be left alone. Updating priority that does not exist will result in an error response.","tags":["helpdesk"]}},"/products":{"get":{"operationId":"getProducts","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for products last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all products are returned in a paginated fashion.","in":"query","name":"where","required":false,"type":"string"},{"description":"Specify if deleted products should be included in the search.","in":"query","name":"includeDeleted","required":false,"type":"boolean"},{"description":"The number of results to fetch in a given page. When this parameter is omitted, a maximum of 200 results are returned.","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/Product"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Find products in the eCommerce system, using the provided CEQL search expression. The search expression in CEQL is the WHERE clause in a typical SQL query, but without the WHERE keyword. For example, to search for all products whose name contains the word 'data', the search expression parameter will be where=name like '%data%'. If a search expression is not provided, then the first 200 records will be returned.

If a value of true is specified for the includeDeleted flag, then any soft-deleted records will also be considered in the searched records.","tags":["ecommerce"]},"post":{"operationId":"createProduct","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The Product object to be created.
With the exception of the 'id' field, the required fields indicated in the 'Product' model are those required to create a new product.","in":"body","name":"product","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Create a new product in the eCommerce system. Product creation will flow through Cloud Elements to your eCommerce service. With the exception of the 'id' field, the required fields indicated in the 'Product' model are those required to create a new product.","tags":["ecommerce"]}},"/products/{id}":{"delete":{"operationId":"deleteProductById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the product to delete from the eCommerce system.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete a product associated with a given ID from your eCommerce system.\nSpecifying a product associated with a given ID that does not exist will result in an error message.","tags":["ecommerce"]},"get":{"operationId":"getProductById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the product to retrieve from the eCommerce system.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve a product associated with a given ID from the eCommerce system.Specifying a product with a specified ID that does not exist will result in an error response.","tags":["ecommerce"]},"patch":{"operationId":"updateProductById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the product to update in the eCommerce system.","in":"path","name":"id","required":true,"type":"string"},{"description":"The product object, with those fields that are to be updated.","in":"body","name":"product","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update a product associated with a given ID in the eCommerce system. The update API uses the PATCH HTTP verb, so only those fields provided in the product object will be updated, and those fields not provided will be left aloneUpdating a product with a specified ID that does not exist will result in an error response.","tags":["ecommerce"]}},"/products/{productId}":{"delete":{"operationId":"deleteProductByProductId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The product ID","in":"path","name":"productId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete a product","tags":["erp"]},"get":{"operationId":"getProductByProductId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The product ID","in":"path","name":"productId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve a product","tags":["erp"]},"patch":{"operationId":"updateProductByProductId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The product ID","in":"path","name":"productId","required":true,"type":"string"},{"description":"The product","in":"body","name":"product","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update a product","tags":["erp"]}},"/purchase-orders":{"get":{"operationId":"getPurchaseOrders","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for accounts last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all purchase orders are returned ","in":"query","name":"where","required":false,"type":"string"},{"description":"The page size for pagination, which defaults to 200 if not supplied","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/PurchaseOrder"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Find Purchase Orders in the Finance System, using the provided CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for Purchase Orders last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all Purchase Orders are returned.","tags":["finance"]},"post":{"operationId":"createPurchaseOrder","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The PurchaseOrder object to be created.
With the exception of the 'id' field, the required fields indicated in the 'PurchaseOrder' model are those required to create a new purchase order","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Create a Purchase Order in the Finance system. Purchase Order creation will flow through Cloud Elements to the Finance Service.","tags":["finance"]}},"/purchase-orders/{id}":{"delete":{"operationId":"deletePurchaseOrderById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the purchase order to delete in the Finance system.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete a Purchase Order associated with a given ID from the Finance system. Specifying a Purchase Order associated with a given ID that does not exist will result in an error message.","tags":["finance"]},"get":{"operationId":"getPurchaseOrderById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The Id of the purchase order to retrieve from the finance system.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve a defined Purchase Order associated with a given ID from the Finance system. Specifying a Purchase Order with an associated ID that does not exist will result in an error response.","tags":["finance"]},"patch":{"operationId":"updatePurchaseOrderById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the purchase order to update in the Finance system.","in":"path","name":"id","required":true,"type":"string"},{"description":"The PurchaseOrder object, with those fields that are to be updated.","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update a Purchase Order given a set of partial attributes associated with a given ID in the Finance system. The update API uses the PATCH HTTP verb, so only those fields provided in the payment object will be updated, and those fields not provided will be left alone. Updating a Purchase Order with a specified ID that does not exist will result in an error response.","tags":["finance"]}},"/purchase-orders/{purchaseOrderId}":{"delete":{"operationId":"deletePurchaseOrderByPurchaseOrderId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The purchase order ID","in":"path","name":"purchaseOrderId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete a purchase order","tags":["erp"]},"get":{"operationId":"getPurchaseOrderByPurchaseOrderId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The purchase order ID","in":"path","name":"purchaseOrderId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve a purchase order","tags":["erp"]},"patch":{"operationId":"updatePurchaseOrderByPurchaseOrderId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The purchase order ID","in":"path","name":"purchaseOrderId","required":true,"type":"string"},{"description":"The purchase order","in":"body","name":"purchaseOrder","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update a purchase order","tags":["erp"]}},"/query":{"get":{"operationId":"getQuery","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The CEQL query. When this parameter is omitted, all objects of the given type are returned. Endpoint limiters may still apply.","in":"query","name":"q","required":true,"type":"string"},{"description":"The page size for pagination, which defaults to 200 if not supplied","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Query for objects in the HumanCapital system using CEQL.","tags":["humancapital"]}},"/reports/metadata":{"get":{"operationId":"getReportsMetadata","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/ReportMetadata"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve the metadata for all the Reports available in the Finance system.","tags":["finance"]}},"/reports/{id}":{"get":{"operationId":"getReportById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID or name of the report to retrieve in the Finance system.","in":"path","name":"id","required":true,"type":"string"},{"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query.","in":"query","name":"where","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/Report"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve the report data for the report with the given name from the Finance System. The provided CEQL search expression, or the where clause is used to filter/constrain the data retrieved by the report.","tags":["finance"]}},"/requisitions":{"get":{"operationId":"getRequisitions","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for requisitions last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all requisitions are returned in a paginated fashion.","in":"query","name":"where","required":false,"type":"string"},{"description":"Specify if deleted requisitions should be included in the search.","in":"query","name":"includeDeleted","required":false,"type":"boolean"},{"description":"The page size for pagination, which defaults to 200 if not supplied","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Find requisitions in the HumanCapital system, using the provided CEQL search expression. The search expression in CEQL is the WHERE clause in a typical SQL query, but without the WHERE keyword. For example, to search for all requisitions whose name contains the word 'data', the search expression parameter will be where=name like '%data%'. If a search expression is not provided, then the first 200 records will be returned.

If a value of true is specified for the includeDeleted flag, then any soft-deleted records will also be considered in the searched records.","tags":["humancapital"]},"post":{"operationId":"createRequisition","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The Requisition object to be created.
With the exception of the 'id' field, the required fields indicated in the 'Requisition' model are those required to create a new Requisition.","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Create a new Requisition in the Human Capital system. Requisition creation will flow through Cloud Elements to your Human Capital service. With the exception of the 'id' field, the required fields indicated in the 'Requisition' model are those required to create a new requisition.","tags":["humancapital"]}},"/requisitions/{id}":{"delete":{"operationId":"deleteRequisitionById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the requisition to delete from the CRM system.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete an requisition associated with a given ID from your CRM system.\nSpecifying an requisition associated with a given ID that does not exist will result in an error message.","tags":["humancapital"]},"get":{"operationId":"getRequisitionById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the requisition to retrieve from the CRM system.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve an requisition associated with a given ID from the CRM system.Specifying an requisition with a specified ID that does not exist will result in an error response.","tags":["humancapital"]},"patch":{"operationId":"updateRequisitionById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the requisition to update in the CRM system.","in":"path","name":"id","required":true,"type":"string"},{"description":"The requisition object, with those fields that are to be updated.","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update an requisition associated with a given ID in the CRM system. The update API uses the PATCH HTTP verb, so only those fields provided in the requisition object will be updated, and those fields not provided will be left aloneUpdating an requisition with a specified ID that does not exist will result in an error response.","tags":["humancapital"]}},"/search":{"get":{"operationId":"getSearch","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The full path to the folder to start searching from (e.g. /myDirectory)","in":"query","name":"path","required":false,"type":"string"},{"description":"Text in the file or folder name","in":"query","name":"text","required":false,"type":"string"},{"description":"The start date (based on the created date of the file or folder) if used, end date is required","format":"date-time","in":"query","name":"startDate","required":false,"type":"string"},{"description":"The end date (based on the created date of the file or folder) if used, start date is required","format":"date-time","in":"query","name":"endDate","required":false,"type":"string"},{"description":"Any tags associated with the files (not applicable to folders)","in":"query","items":{"type":"string"},"name":"tags[]","required":false,"type":"array"},{"description":"The page size for pagination, which defaults to 200 if not supplied","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/CloudFile"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Performs a text search of file names and directory names. The content of files is not searched. The search uses substring matching so searching for \"exam\" will match on \"example.txt\". Subdirectories are also searched. The search returns a list of CloudFiles that match search parameters.","tags":["documents"]}},"/statuses":{"get":{"operationId":"getStatuses","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for incident types last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all statuses are returned in a paginated fashion.","in":"query","name":"where","required":false,"type":"string"},{"description":"Specify if deleted incidents should be included in the search.","in":"query","name":"includeDeleted","required":false,"type":"boolean"},{"description":"The number of results to return per page","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/Status"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Search for Status or statuses in the help desk system, using the provided CEQL search expression. The search expression in CEQL is the WHERE clause in a typical SQL query, but without the WHERE keyword. For example, to search for all statuses whose type contains the word 'completed', the search expression parameter will be where=type='%completed%'. Performing a search without these parameters will not return any results.

If a value of true is specified for the includeDeleted flag, then any soft-deleted records will also be considered in the searched records.","tags":["helpdesk"]},"post":{"operationId":"createStatuse","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The status to create","in":"body","name":"status","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Create a new status field in the help desk system. Status field creation will flow through Cloud Elements to the help desk service. If a Status field already exists will return an error message.","tags":["helpdesk"]}},"/statuses/{id}":{"delete":{"operationId":"deleteStatuseById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the status","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete status field from the help desk system.If the status does not exist will result in an error message.","tags":["helpdesk"]},"get":{"operationId":"getStatuseById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the status","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve status field from the help desk systemStatus field that does not exist will result in an error response.","tags":["helpdesk"]},"patch":{"operationId":"updateStatuseById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the status","in":"path","name":"id","required":true,"type":"string"},{"description":"The status field, containing only the fields to update","in":"body","name":"status","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update status in the help desk system. The update API uses the PATCH HTTP verb, so only those fields provided in the status object will be updated, and those fields not provided will be left alone. Updating status that does not exist will result in an error response.","tags":["helpdesk"]}},"/storage":{"get":{"operationId":"getStorage","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/CloudStorage"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieves the amount of storage available on your cloud service account.","tags":["documents"]}},"/tax-codes":{"get":{"operationId":"getTaxCodes","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for accounts last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all accounts are returned ","in":"query","name":"where","required":false,"type":"string"},{"description":"The page size for pagination, which defaults to 200 if not supplied","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/TaxCode"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Find Tax Codes in the Finance System, using the provided CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for Tax Codes last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all Tax Codes are returned.","tags":["finance"]}},"/tax-codes/{id}":{"get":{"operationId":"getTaxCodeById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The Id of the tax code to retrieve from the finance system.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve a defined Tax Code associated with a given ID from the Finance system. Specifying a Tax Code with an associated ID that does not exist will result in an error response.","tags":["finance"]}},"/tax-codes/{taxCodeId}":{"get":{"operationId":"getTaxCodeByTaxCodeId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The tax code ID","in":"path","name":"taxCodeId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve a tax code","tags":["erp"]}},"/tax-rates":{"get":{"operationId":"getTaxRates","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for accounts last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all accounts are returned ","in":"query","name":"where","required":false,"type":"string"},{"description":"The page size for pagination, which defaults to 200 if not supplied","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/TaxRate"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Find Tax Rates in the Finance System, using the provided CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for Tax Rates last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all Tax Rates are returned.","tags":["finance"]}},"/tax-rates/{id}":{"get":{"operationId":"getTaxRateById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The Id of the Tax Rate to retrieve from the finance system.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve a defined Tax Rate associated with a given ID from the Finance system. Specifying a Tax Rate with an associated ID that does not exist will result in an error response.","tags":["finance"]}},"/tax-rates/{taxRateId}":{"get":{"operationId":"getTaxRateByTaxRateId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The tax rate ID","in":"path","name":"taxRateId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve a tax rate","tags":["erp"]}},"/time-activities":{"get":{"operationId":"getTimeActivities","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for accounts last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all time activities are returned ","in":"query","name":"where","required":false,"type":"string"},{"description":"The page size for pagination, which defaults to 200 if not supplied","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/TimeActivity"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Find Time Activities in the Finance System, using the provided CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for Time Activities last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all Time Activities are returned.","tags":["finance"]},"post":{"operationId":"createTimeActivity","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The TimeActivity object to be created.
With the exception of the 'id' field, the required fields indicated in the 'TimeActivity' model are those required to create a new time activity","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Create a Time Activity in the Finance system. Time Activity creation will flow through Cloud Elements to the Finance Service.","tags":["finance"]}},"/time-activities/{id}":{"delete":{"operationId":"deleteTimeActivityById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the time activity to delete in the Finance system.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete a Time Activity associated with a given ID from the Finance system. Specifying a Time Activity associated with a given ID that does not exist will result in an error message.","tags":["finance"]},"get":{"operationId":"getTimeActivityById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The Id of the time activity to retrieve from the finance system.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve a defined Time Activity associated with a given ID from the Finance system. Specifying a Time Activity with an associated ID that does not exist will result in an error response.","tags":["finance"]},"patch":{"operationId":"updateTimeActivityById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the time activity to update in the Finance system.","in":"path","name":"id","required":true,"type":"string"},{"description":"The TimeActivity object, with those fields that are to be updated.","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update a Time Activity given a set of partial attributes associated with a given ID in the Finance system. The update API uses the PATCH HTTP verb, so only those fields provided in the payment object will be updated, and those fields not provided will be left alone. Updating a Time Activity with a specified ID that does not exist will result in an error response.","tags":["finance"]}},"/time-activities/{timeActivityId}":{"delete":{"operationId":"deleteTimeActivityByTimeActivityId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The time activity ID","in":"path","name":"timeActivityId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete a time activity","tags":["erp"]},"get":{"operationId":"getTimeActivityByTimeActivityId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The time activity ID","in":"path","name":"timeActivityId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve a time activity","tags":["erp"]},"patch":{"operationId":"updateTimeActivityByTimeActivityId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The time activity ID","in":"path","name":"timeActivityId","required":true,"type":"string"},{"description":"The time activity","in":"body","name":"timeActivity","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update a time activity","tags":["erp"]}},"/usage":{"get":{"operationId":"getUsage","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"Number of days to get usage data for.","format":"int64","in":"query","name":"days","required":false,"type":"integer"},{"description":"Retrieve usage data by the given start time for a range/window.","format":"date-time","in":"query","name":"startTime","required":false,"type":"string"},{"description":"Retrieve usage data by the given end time for a range/window.","format":"date-time","in":"query","name":"endTime","required":false,"type":"string"},{"format":"int64","in":"query","name":"aggregate","required":false,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve the usage data for this element. Results can be returned using a variety of parameters such as, number of usage days. A valid User Secret and Element Token are required in the HTTP request.","tags":["messaging"]}},"/usage/analytics/activity":{"get":{"operationId":"getUsageAnalyticsActivity","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"Start time in ISO 8601 format, e.g. '2014-04-14T00:00:00-4:00'. An unspecified time zone defaults to UTC.","in":"query","name":"from","required":true,"type":"string"},{"description":"End time in ISO 8601 format, e.g. '2014-04-14T00:00:00-4:00'. An unspecified time zone defaults to UTC.","in":"query","name":"to","required":true,"type":"string"},{"description":"Interval to be sent for the data to be returned, it can be year, quarter, month, week, day, hour, minute, second","enum":["year","quarter","month","week","day","hour","minute","second"],"in":"query","name":"interval","required":false,"type":"string"},{"description":"The account IDs to search, only applicable for organization admin","in":"query","name":"accountIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/ActivityEntry"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve the number of element API calls within a given date/time range","tags":["usage"]}},"/usage/analytics/activity/elements":{"get":{"operationId":"getUsageAnalyticsActivityElements","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"Start time in ISO 8601 format, e.g. '2014-04-14T00:00:00-4:00'. An unspecified time zone defaults to UTC.","in":"query","name":"from","required":true,"type":"string"},{"description":"End time in ISO 8601 format, e.g. '2014-04-14T00:00:00-4:00'. An unspecified time zone defaults to UTC.","in":"query","name":"to","required":true,"type":"string"},{"description":"Interval to be sent for the data to be returned, it can be year, quarter, month, week, day, hour, minute, second","enum":["year","quarter","month","week","day","hour","minute","second"],"in":"query","name":"interval","required":false,"type":"string"},{"description":"The account IDs to search, only applicable for organization admin","in":"query","name":"accountIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/ActivityElementEntry"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve the number of element API calls for each element within a given date/time range","tags":["usage"]}},"/usage/analytics/statuses":{"get":{"operationId":"getUsageAnalyticsStatuses","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"Start time in ISO 8601 format, e.g. '2014-04-14T00:00:00-4:00'. An unspecified time zone defaults to UTC.","in":"query","name":"from","required":true,"type":"string"},{"description":"End time in ISO 8601 format, e.g. '2014-04-14T00:00:00-4:00'. An unspecified time zone defaults to UTC.","in":"query","name":"to","required":true,"type":"string"},{"description":"Interval to be sent for the data to be returned, it can be year, quarter, month, week, day, hour, minute, second","enum":["year","quarter","month","week","day","hour","minute","second"],"in":"query","name":"interval","required":false,"type":"string"},{"description":"The account IDs to search, only applicable for organization admin","in":"query","name":"accountIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/StatusEntry"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve the number of successes and failures of element API calls within a given date/time range.","tags":["usage"]}},"/usage/analytics/times":{"get":{"operationId":"getUsageAnalyticsTimes","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"Start time in ISO 8601 format, e.g. '2014-04-14T00:00:00-4:00'. An unspecified time zone defaults to UTC.","in":"query","name":"from","required":true,"type":"string"},{"description":"End time in ISO 8601 format, e.g. '2014-04-14T00:00:00-4:00'. An unspecified time zone defaults to UTC.","in":"query","name":"to","required":true,"type":"string"},{"description":"Interval to be sent for the data to be returned, it can be year, quarter, month, week, day, hour, minute, second","enum":["year","quarter","month","week","day","hour","minute","second"],"in":"query","name":"interval","required":false,"type":"string"},{"description":"The account IDs to search, only applicable for organization admin","in":"query","name":"accountIds[]","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/TimesEntry"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve the response times of element API calls within a given date/time range","tags":["usage"]}},"/usage/{id}":{"get":{"operationId":"getUsageById","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of log record","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/TrafficEntry"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve the usage record by id","tags":["usage"]}},"/users":{"get":{"operationId":"getUsers","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The CEQL search expression or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for users created on or after 'Jan 15, 2014', the search expression will be where=createdDate >= '2014-01-15'. When this parameter is omitted, all accounts are returned in a paginated fashion.","in":"query","name":"where","required":false,"type":"string"},{"description":"The record offset at which to begin the paginated results, defaults to 0","format":"int64","in":"query","name":"offset","required":false,"type":"integer"},{"description":"The page size for the paginated results, defaults to 100","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/User"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve users within your account or organization. Find users within your account or organization, using the provided CEQL search expression or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for users containing the name 'greg', the search expression will be where name='greg'. When this parameter is omitted, all accounts are returned in a paginated fashion.","tags":["idmanagement"]}},"/users/me":{"get":{"operationId":"getUsersMe","deprecated":true,"description":"This API has been deprecated please refer to the 'OAuth and User Mgmt' APIs","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/User"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve the current user.","tags":["users"]}},"/users/{emailOrId}":{"get":{"operationId":"getUserByEmailOrId","deprecated":true,"description":"This API has been deprecated please refer to the 'OAuth and User Mgmt' APIs","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The email address or numeric ID of the user","in":"path","name":"emailOrId","required":true,"type":"string"},{"description":"The user's password. If the password is correct, the user secret of this user will also be returned in the response body.","in":"header","name":"Elements-User-Password","required":false,"type":"string"},{"description":"Whether to return inactive users in the response. Deleted users will not be returned even if this is set to true. The default is false","in":"query","name":"includeInactive","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/User"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve a user associated with a given email or ID within your account or organization. Specifying a user associated with a given email or ID that does not exist will result in an error response.","tags":["users"]}},"/users/{id}":{"delete":{"operationId":"deleteUserById","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the user","format":"string","in":"path","name":"id","required":true,"type":"integer"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Delete a user associated with a given email or ID within your account or organization. Specifying a user associated with a given email or ID that does not exist will result in an error response.","tags":["idmanagement"]},"get":{"operationId":"getUserById","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The Id of the user","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve a user associated with a given email or ID within your account or organization. Specifying a user associated with a given email or ID that does not exist will result in an error response.","tags":["idmanagement"]},"patch":{"operationId":"updateUserById","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the user","format":"string","in":"path","name":"id","required":true,"type":"integer"},{"description":"The updated user information","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Update a user associated with a given email or ID within your account or organization. Specifying a user associated with a given email or ID that does not exist will result in an error response.","tags":["idmanagement"]}},"/users/{id}/roles":{"get":{"operationId":"getUsersRoles","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the user.","in":"path","name":"id","required":true,"type":"number"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/Role"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Retrieve the roles that a user has been granted. This will return the effective roles, meaning the role could have been granted at the user level OR at the account level.","tags":["users"]}},"/users/{userId}":{"get":{"operationId":"getUserByUserId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The user ID","in":"string","name":"userId","required":true,"type":"path"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve a user","tags":["social"]}},"/users/{userId}/media":{"get":{"operationId":"getUsersMedia","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The user ID","in":"string","name":"userId","required":true,"type":"path"},{"description":"The CEQL search expression","in":"string","name":"where","required":false,"type":"query"},{"description":"The number of media objects to return","in":"string","name":"count","required":false,"type":"query"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/media"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve media for a user","tags":["social"]}},"/users/{userId}/roles/{roleKey}":{"delete":{"operationId":"deleteUsersRoleByRoleKey","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the user from which the role will be revoked.","in":"path","name":"userId","required":true,"type":"number"},{"description":"The key of the role to revoke (org-admin, org, or admin)","in":"path","name":"roleKey","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Revoke a role from a user. This will only remove roles granted directly to the user, and will not affect roles that may have been granted at the account level.","tags":["users"]},"put":{"operationId":"replaceUsersRoleByRoleKey","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the user to which the role will be granted.","in":"path","name":"userId","required":true,"type":"number"},{"description":"The key of the role to grant (org-admin, org, or admin)","in":"path","name":"roleKey","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Role"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Grant a role to a user.","tags":["users"]}},"/users/{userId}/roles/{roleKey}/privilege/{privilegeKey}":{"put":{"operationId":"replaceUsersRolesPrivilegeByPrivilegeKey","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the user to which the roles privilege will be granted.","in":"path","name":"userId","required":true,"type":"number"},{"description":"The key of the role to which privilege to grant (org-admin, org, or admin)","in":"path","name":"roleKey","required":true,"type":"string"},{"description":"The key of the privilege to grant","in":"path","name":"privilegeKey","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Role"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Grant a privilege to a user role.","tags":["users"]},"delete":{"operationId":"deleteUsersRolesPrivilegeByPrivilegeKey","parameters":[{"description":"The authorization tokens. The format for the header value is 'User <user secret>, Organization <org secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the user to which the roles privilege will be revoked.","in":"path","name":"userId","required":true,"type":"number"},{"description":"The key of the role (org-admin, org, or admin)","in":"path","name":"roleKey","required":true,"type":"string"},{"description":"The key of the privilege to revoke","in":"path","name":"privilegeKey","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"}},"summary":"Revoke a privilege from a user role.","tags":["users"]}},"/vendor-payments":{"get":{"operationId":"getVendorPayments","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The CEQL search expression","in":"query","name":"where","required":false,"type":"string"},{"description":"The page size. Defaults to 200 if not provided. Maximum of 5000","in":"query","name":"pageSize","required":false,"type":"string","format":"int64"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/vendorPayments"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Search for vendor payments","tags":["erp"]},"post":{"operationId":"createVendorPayment","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The vendor payment","in":"body","name":"vendorPayment","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Create a vendor payments","tags":["erp"]}},"/vendor-payments/{vendorPaymentId}":{"delete":{"operationId":"deleteVendorPaymentByVendorPaymentId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The vendor payment ID","in":"path","name":"vendorPaymentId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete a vendor payment","tags":["erp"]},"get":{"operationId":"getVendorPaymentByVendorPaymentId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The vendor payment ID","in":"path","name":"vendorPaymentId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve a vendor payment","tags":["erp"]},"patch":{"operationId":"updateVendorPaymentByVendorPaymentId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The vendor payment ID","in":"path","name":"vendorPaymentId","required":true,"type":"string"},{"description":"The vendor payment","in":"body","name":"vendorPayment","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update a vendor payment","tags":["erp"]}},"/vendors":{"get":{"operationId":"getVendors","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for accounts last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all vendors are returned ","in":"query","name":"where","required":false,"type":"string"},{"description":"The page size for pagination, which defaults to 200 if not supplied","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/Vendor"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Find Vendors in the Finance System, using the provided CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for Vendors last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all Vendors are returned.","tags":["finance"]},"post":{"operationId":"createVendor","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The Vendor object to be created.
With the exception of the 'id' field, the required fields indicated in the 'Vendor' model are those required to create a new vendor","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Create a new Vendor in the Finance system. Vendor creation will flow through Cloud Elements to the Finance Service.","tags":["finance"]}},"/vendors/{id}":{"delete":{"operationId":"deleteVendorById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the vendor to delete in the Finance system.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete a Vendor associated with a given ID from the Finance system. This marks it as inactive in the system Specifying a Vendor associated with a given ID that does not exist will result in an error message.","tags":["finance"]},"get":{"operationId":"getVendorById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The Id of the vendor to retrieve from the finance system.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve a defined Vendor associated with a given ID from the Finance system. Specifying a Vendor with an associated ID that does not exist will result in an error response.","tags":["finance"]},"patch":{"operationId":"updateVendorById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the vendor to update in the Finance system.","in":"path","name":"id","required":true,"type":"string"},{"description":"The Vendor object, with those fields that are to be updated.","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update a Vendor Order given a set of partial attributes associated with a given ID in the Finance system. The update API uses the PATCH HTTP verb, so only those fields provided in the Vendor Order object will be updated, and those fields not provided will be left alone. Updating a Vendor Order with a specified ID that does not exist will result in an error response.","tags":["finance"]}},"/vendors/{vendorId}":{"delete":{"operationId":"deleteVendorByVendorId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The vendor ID","in":"path","name":"vendorId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete a vendor","tags":["erp"]},"get":{"operationId":"getVendorByVendorId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The vendor ID","in":"path","name":"vendorId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve a vendor","tags":["erp"]},"patch":{"operationId":"updateVendorByVendorId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The vendor ID","in":"path","name":"vendorId","required":true,"type":"string"},{"description":"The vendor","in":"body","name":"vendor","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update a vendor","tags":["erp"]}},"/{objectName}":{"get":{"operationId":"getByObjectName","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for objects last modified on or after 'Jan 15, 2014', the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all objects are returned in a paginated fashion.","in":"query","name":"where","required":false,"type":"string"},{"description":"The object name of the object to be searched, e.g., 'account'.","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The page size for pagination, which defaults to 200 if not supplied","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"Specify if deleted objects should be included in the search.","in":"query","name":"includeDeleted","required":false,"type":"boolean"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/Object"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Find objects in the Marketing Automation system, using the provided object name and CEQL search expression. The search expression in CEQL is the WHERE clause in a typical SQL query, but without the WHERE keyword. For example, to search for all contacts whose name contains the word 'data', the search expression parameter will be where=name like '%data%'. If a search expression is not provided, then the first 200 records will be returned.

If a value of true is specified for the includeDeleted flag, then any soft-deleted records will also be considered in the searched records.","tags":["marketing"]},"post":{"operationId":"createByObjectName","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The object name of the object to be created, e.g., 'account'.","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The object to be created.","in":"body","name":"object","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Create a new object in the Marketing Automation service. The provided objectName can be that of a custom or standard object. Object creation will flow through Cloud Elements to your Marketing Automation service.","tags":["marketing"]}},"/{objectName}/{id}":{"delete":{"operationId":"deleteObjectNameById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The object name of the object to be deleted, e.g., 'account'.","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The ID of the object to delete in the Marketing Automation system.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete an object of type with a given object name associated with a given ID from your Marketing Automation system. Specifying an object of type with a given object name associated with a given ID that does not exist will result in an error message.","tags":["marketing"]},"get":{"operationId":"getObjectNameById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The object name of the object to be retrieved, e.g., \"account\".","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The ID of the object to retrieve from the Marketing Automation system.","in":"path","name":"id","required":true,"type":"string"}],"produces":["application/json","application/pdf"],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve an object of type with a given object name and associated with a given ID from your Marketing Automation system. Specifying an object of type with a given object name associated with a given ID that does not exist will result in an error response.","tags":["marketing"]},"patch":{"operationId":"updateObjectNameById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The object name of the object to be updated, e.g., 'account'.","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The ID of the object to update in the Marketing Automation system.","in":"path","name":"id","required":true,"type":"string"},{"description":"The object with those fields that are to be updated.","in":"body","name":"object","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update the object associated with the given object name and ID in the Marketing Automation system. The update API uses the PATCH HTTP verb, so only those fields provided in the object will be updated, and those fields not provided will be left alone.","tags":["marketing"]}},"/{objectName}/{id}/{childObjectName}":{"get":{"operationId":"getObjectNameByChildObjectName","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The object name of the parent object, e.g., list'.","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The ID of the parent object.","in":"path","name":"id","required":true,"type":"string"},{"description":"The object name of the child object to be retrieved, e.g., contact'.","in":"path","name":"childObjectName","required":true,"type":"string"},{"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for users last modified on or after 'Jan 15, 2014',the search expression will be where=lastModifiedDate>='2014-01-15T00:00:00.000Z'. When this parameter is omitted, all users are returned in a paginated fashion.","in":"query","name":"where","required":false,"type":"string"},{"description":"The page size for pagination, which defaults to 200 if not supplied","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve an object associated with the given ID of a parent object.Specifying an object with a specified ID that does not exist will result in an error response.","tags":["finance"]},"post":{"operationId":"createObjectNameByChildObjectName","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The object name of the parent object, e.g., list'.","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The ID of the parent object.","in":"path","name":"id","required":true,"type":"string"},{"description":"The object name of the child object to be retrieved, e.g., contact'.","in":"path","name":"childObjectName","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Create a new child object in a given parent object.","tags":["finance"]}},"/{objectName}/{id}/{childObjectName}/{childId}":{"delete":{"operationId":"deleteObjectNameByChildId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The object name of the parent object, e.g., list'.","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The ID of the parent object.","in":"path","name":"id","required":true,"type":"string"},{"description":"The object name of the child object to be retrieved, e.g., contact'.","in":"path","name":"childObjectName","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Create a new child object in a given parent object.","tags":["finance"]},"get":{"operationId":"getObjectNameByChildId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The object name of the parent object, e.g., list'.","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The ID of the parent object.","in":"path","name":"id","required":true,"type":"string"},{"description":"The object name of the child object to be retrieved, e.g., contact'.","in":"path","name":"childObjectName","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Create a new child object in a given parent object.","tags":["finance"]},"patch":{"operationId":"updateObjectNameByChildId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The object name of the parent object, e.g., list'.","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The ID of the parent object.","in":"path","name":"id","required":true,"type":"string"},{"description":"The object name of the child object to be retrieved, e.g., contact'.","in":"path","name":"childObjectName","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Create a new child object in a given parent object.","tags":["finance"]}},"/{objectName}/{objectId}":{"delete":{"operationId":"deleteObjectNameByObjectId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The object name","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The object ID","in":"path","name":"objectId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete an object","tags":["humancapital"]},"get":{"operationId":"getObjectNameByObjectId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The object name","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The object ID","in":"path","name":"objectId","required":true,"type":"string"}],"produces":["application/json","application/pdf"],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve an object","tags":["humancapital"]},"patch":{"operationId":"updateObjectNameByObjectId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The object name","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The object ID","in":"path","name":"objectId","required":true,"type":"string"},{"description":"The object","in":"body","name":"object","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update an object","tags":["humancapital"]}},"/{objectName}/{objectId}/{childObjectName}":{"get":{"operationId":"getObjectNameByChildObjectName","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The object name","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The object Id","in":"path","name":"objectId","required":true,"type":"string"},{"description":"The child object name","in":"path","name":"childObjectName","required":true,"type":"string"},{"description":"The CEQL search expression","in":"query","name":"where","required":false,"type":"string"},{"description":"The page size. Defaults to 200 if not provided. Maximum of 5000","in":"query","name":"pageSize","required":false,"type":"string","format":"int64"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide","items":{"$ref":"#/definitions/objects"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Search for child objects for an object","tags":["erp"]},"post":{"operationId":"createObjectNameByChildObjectName","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The object","in":"body","name":"object","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},{"description":"The object name","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The object Id","in":"path","name":"objectId","required":true,"type":"string"},{"description":"The child object name","in":"path","name":"childObjectName","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Create a child object for an object","tags":["erp"]}},"/{objectName}/{objectId}/{childObjectName}/{childObjectId}":{"delete":{"operationId":"deleteObjectNameByChildObjectId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The object name","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The object ID","in":"path","name":"objectId","required":true,"type":"string"},{"description":"The child object name","in":"path","name":"childObjectName","required":true,"type":"string"},{"description":"The child object Id","in":"path","name":"childObjectId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete a child object for an object","tags":["erp"]},"get":{"operationId":"getObjectNameByChildObjectId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The object name","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The object ID","in":"path","name":"objectId","required":true,"type":"string"},{"description":"The child object name","in":"path","name":"childObjectName","required":true,"type":"string"},{"description":"The child object Id","in":"path","name":"childObjectId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve a child object for an object","tags":["erp"]},"patch":{"operationId":"updateObjectNameByChildObjectId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The object name","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The object ID","in":"path","name":"objectId","required":true,"type":"string"},{"description":"The child object name","in":"path","name":"childObjectName","required":true,"type":"string"},{"description":"The child object Id","in":"path","name":"childObjectId","required":true,"type":"string"},{"description":"The object","in":"body","name":"object","required":true,"schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/The untransformed request/response data model varies by individual Element in the Hub. The default payload can be transformed to a normalized model using our data transformation service. To try it out, create a new instance of the element(s) you wish to integrate, and then access the documentation for that specific data model. For instructions on how to create an instance, refer to: Cloud Elements Instances Usage Guide"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update a child object for an object","tags":["erp"]}}},"host":"api.cloud-elements.com","schemes":["https"],"definitions":{"EventPayloadBodyNotificationCallbackHeaders":{"type":"object","title":"callbackHeaders","properties":{"myKey":{"x-samplevalue":"myValue","type":"string"}}},"EventPayloadBodyNotification":{"type":"object","title":"notification","properties":{"callbackHeaders":{"$ref":"#/definitions/EventPayloadBodyNotificationCallbackHeaders"},"basicPassword":{"x-samplevalue":"myPass","type":"string"},"signatureKey":{"x-samplevalue":"jdbfbd","type":"string"},"basicUsername":{"x-samplevalue":"myUser","type":"string"},"url":{"x-samplevalue":"https://notify.me/","type":"string"},"batchSize":{"x-samplevalue":"10","type":"integer","format":"int32"},"includeRaw":{"x-samplevalue":"true","type":"boolean"}}},"EventPayloadBody":{"title":"EventPayloadBody","properties":{"notification":{"$ref":"#/definitions/EventPayloadBodyNotification"},"objectNames":{"x-samplevalue":["SurveyResponseItemAttachmentsCollection","Opportunity","Contact"],"type":"array","items":{"type":"string"}}},"type":"object"},"ElementInstancePutElementResourcesModelSwaggerContactObject":{"type":"object","title":"contactObject","properties":{"title":{"x-samplevalue":"contactObject","type":"string"},"type":{"x-samplevalue":"object","type":"string"},"properties":{"$ref":"#/definitions/ElementInstancePutElementResourcesModelSwaggerContactObjectProperties"}}},"ElementInstancePutElementResourcesModel":{"type":"object","title":"model","properties":{"transform":{"x-samplevalue":false,"type":"boolean"},"name":{"x-samplevalue":"modelName","type":"string"},"swagger":{"$ref":"#/definitions/ElementInstancePutElementResourcesModelSwagger"}}},"ElementInstancePutElementResourcesModelSwaggerContactObjectProperties":{"type":"object","title":"properties","properties":{"id":{"$ref":"#/definitions/ElementInstancePutElementResourcesModelSwaggerContactObjectPropertiesId"}}},"ElementInstancePutElementHooks":{"title":"hooks","properties":{"elementId":{"x-samplevalue":364,"format":"int32","type":"integer"},"isLegacy":{"x-samplevalue":false,"type":"boolean"},"contextParams":{"type":"string"},"id":{"x-samplevalue":805,"format":"int32","type":"integer"},"mimeType":{"x-samplevalue":"application/javascript","type":"string"},"type":{"x-samplevalue":"postRequest","type":"string"},"body":{"x-samplevalue":"done()","type":"string"}},"type":"object"},"ElementInstancePutElementAuthentication":{"type":"object","title":"authentication","properties":{"type":{"x-samplevalue":"custom","type":"string"}}},"ElementInstancePutElementResourcesResponse":{"type":"object","title":"response","properties":{"contentTypeAsString":{"x-samplevalue":"application/json","type":"string"},"contentType":{"x-samplevalue":"application/json","type":"string"}}},"ElementInstancePutElementResourcesModelSwaggerContactObjectPropertiesId":{"type":"object","title":"id","properties":{"x-samplevalue":{"x-samplevalue":"fioa","type":"string"},"type":{"x-samplevalue":"string","type":"string"}}},"ElementInstancePutElementResourcesModelSwaggerModelName":{"type":"object","title":"modelName","properties":{"type":{"x-samplevalue":"array","type":"string"},"items":{"$ref":"#/definitions/ElementInstancePutElementResourcesModelSwaggerModelNameItems"}}},"ElementInstancePutElement":{"type":"object","title":"element","properties":{"version":{"x-samplevalue":"1.0.0","type":"string"},"private":{"x-samplevalue":true,"type":"boolean"},"configuration":{"type":"array","items":{"$ref":"#/definitions/ElementInstancePutElementConfiguration"}},"objects":{"type":"array","items":{"$ref":"#/definitions/ElementInstancePostElementObjects"}},"description":{"x-samplevalue":"A dummy element that responds with fixed responses","type":"string"},"cloneable":{"x-samplevalue":false,"type":"boolean"},"extended":{"x-samplevalue":false,"type":"boolean"},"bulkDownloadEnabled":{"x-samplevalue":false,"type":"boolean"},"useModelsForMetadata":{"x-samplevalue":true,"type":"boolean"},"paginatorVersion":{"x-samplevalue":"V2","type":"string"},"trialAccount":{"x-samplevalue":false,"type":"boolean"},"logo":{"x-samplevalue":"dummy","type":"string"},"id":{"x-samplevalue":364,"format":"int32","type":"integer"},"hooks":{"type":"array","items":{"$ref":"#/definitions/ElementInstancePutElementHooks"}},"key":{"x-samplevalue":"dummy","type":"string"},"beta":{"x-samplevalue":false,"type":"boolean"},"authentication":{"$ref":"#/definitions/ElementInstancePutElementAuthentication"},"bulkUploadEnabled":{"x-samplevalue":false,"type":"boolean"},"image":{"x-samplevalue":"elements/custom-element-default-logo.png","type":"string"},"active":{"x-samplevalue":true,"type":"boolean"},"resources":{"type":"array","items":{"$ref":"#/definitions/ElementInstancePutElementResources"}},"modelType":{"x-samplevalue":"basic","type":"string"},"protocolType":{"x-samplevalue":"http","type":"string"},"transformationsEnabled":{"x-samplevalue":true,"type":"boolean"},"childTransformationsEnabled":{"x-samplevalue":true,"type":"boolean"},"deleted":{"x-samplevalue":false,"type":"boolean"},"hub":{"x-samplevalue":"general","type":"string"},"typeOauth":{"x-samplevalue":false,"type":"boolean"},"name":{"x-samplevalue":"dummy","type":"string"},"extendable":{"x-samplevalue":true,"type":"boolean"},"parameters":{"type":"array","items":{"$ref":"#/definitions/ElementInstancePutElementParameters"}}}},"ElementInstancePutElementConfiguration":{"title":"configuration","properties":{"internal":{"x-samplevalue":false,"type":"boolean"},"companyConfig":{"x-samplevalue":false,"type":"boolean"},"defaultValue":{"x-samplevalue":"100","type":"string"},"displayOrder":{"x-samplevalue":1,"format":"int32","type":"integer"},"description":{"x-samplevalue":"dummy Base Url","type":"string"},"active":{"x-samplevalue":true,"type":"boolean"},"isPrivate":{"x-samplevalue":false,"type":"boolean"},"type":{"x-samplevalue":"TEXTFIELD_1000","type":"string"},"resellerConfig":{"x-samplevalue":false,"type":"boolean"},"required":{"x-samplevalue":true,"type":"boolean"},"hideFromConsole":{"x-samplevalue":true,"type":"boolean"},"name":{"x-samplevalue":"Base Url","type":"string"},"id":{"x-samplevalue":9702,"format":"int32","type":"integer"},"groupControl":{"x-samplevalue":false,"type":"boolean"},"key":{"x-samplevalue":"base.url","type":"string"}},"type":"object"},"ElementInstancePutElementResourcesModelSwaggerModelNameItems":{"type":"object","title":"items","properties":{"type":{"x-samplevalue":"contactObject","type":"string"}}},"ElementInstancePutElementResourcesParameters":{"title":"parameters","properties":{"vendorType":{"x-samplevalue":"query","type":"string"},"resourceId":{"x-samplevalue":18389,"format":"int32","type":"integer"},"dataType":{"x-samplevalue":"string","type":"string"},"description":{"x-samplevalue":"The number of resources to return in a given page","type":"string"},"vendorDataType":{"x-samplevalue":"string","type":"string"},"updatedDate":{"x-samplevalue":"2021-02-10T19:52:12Z","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"},"source":{"x-samplevalue":"request","type":"string"},"vendorName":{"x-samplevalue":"pageSize","type":"string"},"type":{"x-samplevalue":"query","type":"string"},"required":{"x-samplevalue":false,"type":"boolean"},"createdDate":{"x-samplevalue":"2020-11-30T04:39:28Z","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"},"name":{"x-samplevalue":"pageSize","type":"string"},"id":{"x-samplevalue":43580,"format":"int32","type":"integer"}},"type":"object"},"ElementInstancePutUser":{"type":"object","title":"user","properties":{"firstName":{"x-samplevalue":"Rahul","type":"string"},"lastName":{"x-samplevalue":"Gupta","type":"string"},"emailAddress":{"x-sub-format":"email","x-samplevalue":"rahulgupta5595@gmail.com","type":"string"},"id":{"x-samplevalue":4,"format":"int32","type":"integer"}}},"ElementInstancePutElementResourcesModelSwagger":{"type":"object","title":"swagger","properties":{"modelName":{"$ref":"#/definitions/ElementInstancePutElementResourcesModelSwaggerModelName"},"contactObject":{"$ref":"#/definitions/ElementInstancePutElementResourcesModelSwaggerContactObject"}}},"ElementInstancePutElementResourcesHooks":{"title":"hooks","properties":{"resourceId":{"x-samplevalue":18387,"format":"int32","type":"integer"},"isLegacy":{"x-samplevalue":false,"type":"boolean"},"contextParams":{"x-samplevalue":"response_body","type":"string"},"id":{"x-samplevalue":29019,"format":"int32","type":"integer"},"mimeType":{"x-samplevalue":"application/javascript","type":"string"},"type":{"x-samplevalue":"preRequest","type":"string"},"body":{"x-samplevalue":"done()","type":"string"}},"type":"object"},"ElementInstancePutElementResources":{"title":"resources","properties":{"method":{"x-samplevalue":"GET","type":"string"},"kind":{"x-samplevalue":"eb","type":"string"},"description":{"x-samplevalue":"Search for faar","type":"string"},"updatedDate":{"x-samplevalue":"2021-02-10T19:52:12Z","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"},"type":{"x-samplevalue":"api","type":"string"},"vendorPath":{"x-samplevalue":"faar","type":"string"},"path":{"x-samplevalue":"/hubs/general/faar","type":"string"},"formulaId":{"x-samplevalue":40,"format":"int32","type":"integer"},"createdDate":{"x-samplevalue":"2020-11-22T18:51:59Z","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"},"vendorMethod":{"x-samplevalue":"GET","type":"string"},"response":{"$ref":"#/definitions/ElementInstancePutElementResourcesResponse"},"ownerAccountId":{"x-samplevalue":4,"format":"int32","type":"integer"},"objectName":{"x-samplevalue":"contacts","type":"string"},"tryitoutDisable":{"x-samplevalue":false,"type":"boolean"},"model":{"$ref":"#/definitions/ElementInstancePutElementResourcesModel"},"id":{"x-samplevalue":18389,"format":"int32","type":"integer"},"parameters":{"type":"array","items":{"$ref":"#/definitions/ElementInstancePutElementResourcesParameters"}},"hooks":{"type":"array","items":{"$ref":"#/definitions/ElementInstancePutElementResourcesHooks"}}},"type":"object"},"ElementInstancePutElementParameters":{"title":"parameters","properties":{"vendorType":{"x-samplevalue":"header","type":"string"},"elementId":{"x-samplevalue":364,"format":"int32","type":"integer"},"createdDate":{"x-samplevalue":"2020-11-22T18:44:02Z","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"},"name":{"x-samplevalue":"application/json","type":"string"},"id":{"x-samplevalue":568,"format":"int32","type":"integer"},"updatedDate":{"x-samplevalue":"2021-02-10T19:52:12Z","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"},"source":{"x-samplevalue":"request","type":"string"},"vendorName":{"x-samplevalue":"Content-Type","type":"string"},"type":{"x-samplevalue":"value","type":"string"},"required":{"x-samplevalue":false,"type":"boolean"}},"type":"object"},"ElementInstancePutConfiguration":{"type":"object","title":"configuration","properties":{"config_property_name_placeholder":{"x-samplevalue":"string","type":"string"}}},"ElementInstancePut":{"title":"ElementInstancePut","properties":{"configuration":{"$ref":"#/definitions/ElementInstancePutConfiguration"},"eventsEnabled":{"x-samplevalue":false,"type":"boolean"},"userId":{"x-samplevalue":4,"format":"int32","type":"integer"},"token":{"x-samplevalue":"fZ1nIN+2c+TSPDiaJYym/0eC/eNvmkTYqc98hjhc4Y4=","type":"string"},"valid":{"x-samplevalue":true,"type":"boolean"},"organizationId":{"x-samplevalue":4,"format":"int32","type":"integer"},"accountId":{"x-samplevalue":4,"format":"int32","type":"integer"},"name":{"x-samplevalue":"SAP Business One Updated","type":"string"},"modifiedDate":{"x-samplevalue":"2021-02-10T19:59:31Z","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"},"consecutiveRefreshFailureCount":{"x-samplevalue":0,"format":"int32","type":"integer"},"disabled":{"x-samplevalue":false,"type":"boolean"},"id":{"x-samplevalue":863,"format":"int32","type":"integer"},"user":{"$ref":"#/definitions/ElementInstancePutUser"},"externalAuthentication":{"x-samplevalue":"none","type":"string"},"element":{"$ref":"#/definitions/ElementInstancePutElement"}},"type":"object"},"ElementInstancePostElementObjectMetadataCurrencyrates":{"type":"object","title":"currencyrates","properties":{"fields":{"type":"array","items":{"$ref":"#/definitions/ElementInstancePostElementObjectMetadataCurrencyratesFields"}}}},"ElementInstancePostUser":{"type":"object","title":"user","properties":{"firstName":{"x-samplevalue":"Rahul","type":"string"},"lastName":{"x-samplevalue":"Gupta","type":"string"},"emailAddress":{"x-samplevalue":"rahul@cloud-elements.com","type":"string"},"id":{"x-samplevalue":24425,"format":"int32","type":"integer"}}},"ElementInstancePostElementAuthentication":{"type":"object","title":"authentication","properties":{"type":{"x-samplevalue":"custom","type":"string"}}},"ElementInstancePostElementParameters":{"title":"parameters","properties":{"vendorType":{"x-samplevalue":"header","type":"string"},"elementId":{"x-samplevalue":52410,"format":"int32","type":"integer"},"createdDate":{"x-samplevalue":"2021-02-12T03:04:18Z","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"},"name":{"x-samplevalue":"application/json","type":"string"},"id":{"x-samplevalue":46121,"format":"int32","type":"integer"},"updatedDate":{"x-samplevalue":"2021-02-12T03:04:25Z","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"},"source":{"x-samplevalue":"request","type":"string"},"vendorName":{"x-samplevalue":"Accept","type":"string"},"type":{"x-samplevalue":"value","type":"string"},"required":{"x-samplevalue":false,"type":"boolean"}},"type":"object"},"ElementInstancePostElementHooks":{"title":"hooks","properties":{"elementId":{"x-samplevalue":52410,"format":"int32","type":"integer"},"isLegacy":{"x-samplevalue":false,"type":"boolean"},"contextParams":{"type":"string"},"id":{"x-samplevalue":11498,"format":"int32","type":"integer"},"mimeType":{"x-samplevalue":"application/javascript","type":"string"},"type":{"x-samplevalue":"postRequest","type":"string"},"body":{"x-samplevalue":"done()","type":"string"}},"type":"object"},"ElementInstancePostElementResourcesHooks":{"title":"hooks","properties":{"resourceId":{"x-samplevalue":571873,"format":"int32","type":"integer"},"isLegacy":{"x-samplevalue":false,"type":"boolean"},"contextParams":{"type":"string"},"id":{"x-samplevalue":102257,"format":"int32","type":"integer"},"mimeType":{"x-samplevalue":"application/javascript","type":"string"},"type":{"x-samplevalue":"preRequest","type":"string"},"body":{"x-samplevalue":"done()","type":"string"}},"type":"object"},"ElementInstancePostElementObjectMetadata":{"type":"object","title":"objectMetadata","properties":{"currencyrates":{"$ref":"#/definitions/ElementInstancePostElementObjectMetadataCurrencyrates"}}},"ElementInstancePost":{"title":"ElementInstancePost","properties":{"configuration":{"$ref":"#/definitions/ElementInstancePostConfiguration"},"traceLoggingEnabled":{"x-samplevalue":false,"type":"boolean"},"valid":{"x-samplevalue":true,"type":"boolean"},"pollingForceDisabled":{"x-samplevalue":false,"type":"boolean"},"organizationId":{"x-samplevalue":976,"format":"int32","type":"integer"},"consecutiveRefreshFailureCount":{"x-samplevalue":0,"format":"int32","type":"integer"},"disabled":{"x-samplevalue":false,"type":"boolean"},"id":{"x-samplevalue":401877,"format":"int32","type":"integer"},"externalAuthentication":{"x-samplevalue":"none","type":"string"},"element":{"$ref":"#/definitions/ElementInstancePostElement"},"elementId":{"x-samplevalue":52410,"format":"int32","type":"integer"},"lastHeartbeatCheckTime":{"x-samplevalue":0,"format":"int32","type":"integer"},"eventsEnabled":{"x-samplevalue":false,"type":"boolean"},"cachingEnabled":{"x-samplevalue":false,"type":"boolean"},"userId":{"x-samplevalue":24425,"format":"int32","type":"integer"},"token":{"x-samplevalue":"U38H5ZYkPi1yKsWwPYAi+1Ieg3g7TssDFsRLWJBzo8E=","type":"string"},"tags":{"x-samplevalue":["dummy 2"],"type":"array","items":{"type":"string"}},"accountId":{"x-samplevalue":18937,"format":"int32","type":"integer"},"createdDate":{"x-samplevalue":"2021-02-12T03:05:43Z","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"},"maxCacheSize":{"x-samplevalue":0,"format":"int32","type":"integer"},"name":{"x-samplevalue":"dummy 2","type":"string"},"modifiedDate":{"x-samplevalue":"2021-02-12T03:05:43Z","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"},"cacheTimeToLive":{"x-samplevalue":0,"format":"int32","type":"integer"},"authenticationType":{"x-samplevalue":"custom","type":"string"},"user":{"$ref":"#/definitions/ElementInstancePostUser"}},"type":"object"},"ElementInstancePostElementDefaultTransformations":{"title":"defaultTransformations","properties":{"name":{"x-samplevalue":"customers","type":"string"},"vendorName":{"x-samplevalue":"customers","type":"string"}},"type":"object"},"ElementInstancePostElementResources":{"title":"resources","properties":{"method":{"x-samplevalue":"GET","type":"string"},"kind":{"x-samplevalue":"eb","type":"string"},"description":{"x-samplevalue":"Search for contacts","type":"string"},"updatedDate":{"x-samplevalue":"2021-02-12T03:04:25Z","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"},"type":{"x-samplevalue":"api","type":"string"},"vendorPath":{"x-samplevalue":"/contacts","type":"string"},"path":{"x-samplevalue":"/hubs/general/contacts","type":"string"},"createdDate":{"x-samplevalue":"2021-02-12T03:04:18Z","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"},"vendorMethod":{"x-samplevalue":"GET","type":"string"},"response":{"$ref":"#/definitions/ElementInstancePostElementResourcesResponse"},"ownerAccountId":{"x-samplevalue":18937,"format":"int32","type":"integer"},"objectName":{"x-samplevalue":"contacts","type":"string"},"tryitoutDisable":{"x-samplevalue":false,"type":"boolean"},"model":{"$ref":"#/definitions/ElementInstancePostElementResourcesModel"},"id":{"x-samplevalue":571873,"format":"int32","type":"integer"},"parameters":{"type":"array","items":{"$ref":"#/definitions/ElementInstancePostElementResourcesParameters"}},"hooks":{"type":"array","items":{"$ref":"#/definitions/ElementInstancePostElementResourcesHooks"}}},"type":"object"},"ElementInstancePostElementObjectMetadataCurrencyratesFields":{"title":"fields","properties":{"vendorDisplayName":{"x-samplevalue":"RateDate","type":"string"},"vendorReadOnly":{"x-samplevalue":false,"type":"boolean"},"vendorNativeType":{"x-samplevalue":"string","type":"string"},"type":{"x-samplevalue":"string","type":"string"},"vendorPath":{"x-samplevalue":"RateDate","type":"string"}},"type":"object"},"ElementInstancePostElementObjects":{"title":"objects","properties":{"elementId":{"x-samplevalue":52410,"format":"int32","type":"integer"},"bulkUploadEnabled":{"x-samplevalue":true,"type":"boolean"},"metadataDiscovery":{"x-samplevalue":false,"type":"boolean"},"updatedDateName":{"type":"string"},"createdDateName":{"type":"string"},"eventsEnabled":{"x-samplevalue":false,"type":"boolean"},"eventCreatedSupported":{"x-samplevalue":false,"type":"boolean"},"nativeBulkUpload":{"x-samplevalue":false,"type":"boolean"},"tags":{"x-samplevalue":["tag1"],"type":"array","items":{"type":"string"}},"createdDateFormat":{"type":"string"},"updatedDateFormat":{"type":"string"},"bulkDownloadEnabled":{"x-samplevalue":true,"type":"boolean"},"ownerAccountId":{"x-samplevalue":18937,"format":"int32","type":"integer"},"name":{"x-samplevalue":"contacts","type":"string"},"operationsSupported":{"x-samplevalue":["unknown"],"type":"array","items":{"type":"string"}},"hulkDownloadEnabled":{"x-samplevalue":false,"type":"boolean"},"eventUpdatedSupported":{"x-samplevalue":false,"type":"boolean"},"id":{"x-samplevalue":89140,"format":"int32","type":"integer"},"primaryKeyName":{"x-samplevalue":"id","type":"string"},"nativeBulkDownload":{"x-samplevalue":false,"type":"boolean"},"migrated":{"x-samplevalue":false,"type":"boolean"},"hulkUploadEnabled":{"x-samplevalue":false,"type":"boolean"},"eventDeletedSupported":{"x-samplevalue":false,"type":"boolean"}},"type":"object"},"ElementInstancePostElement":{"type":"object","title":"element","properties":{"version":{"x-samplevalue":"1.0.0","type":"string"},"private":{"x-samplevalue":true,"type":"boolean"},"objects":{"type":"array","items":{"$ref":"#/definitions/ElementInstancePostElementObjects"}},"description":{"x-samplevalue":"A dummy element that responds with fixed responses","type":"string"},"cloneable":{"x-samplevalue":false,"type":"boolean"},"extended":{"x-samplevalue":false,"type":"boolean"},"bulkDownloadEnabled":{"x-samplevalue":false,"type":"boolean"},"useModelsForMetadata":{"x-samplevalue":true,"type":"boolean"},"paginatorVersion":{"x-samplevalue":"V2","type":"string"},"trialAccount":{"x-samplevalue":false,"type":"boolean"},"logo":{"x-samplevalue":"dummy","type":"string"},"id":{"x-samplevalue":52410,"format":"int32","type":"integer"},"hooks":{"type":"array","items":{"$ref":"#/definitions/ElementInstancePostElementHooks"}},"key":{"x-samplevalue":"dummy","type":"string"},"beta":{"x-samplevalue":false,"type":"boolean"},"authentication":{"$ref":"#/definitions/ElementInstancePostElementAuthentication"},"bulkUploadEnabled":{"x-samplevalue":false,"type":"boolean"},"image":{"x-samplevalue":"elements/custom-element-default-logo.png","type":"string"},"active":{"x-samplevalue":true,"type":"boolean"},"resources":{"type":"array","items":{"$ref":"#/definitions/ElementInstancePostElementResources"}},"modelType":{"x-samplevalue":"basic","type":"string"},"protocolType":{"x-samplevalue":"http","type":"string"},"transformationsEnabled":{"x-samplevalue":true,"type":"boolean"},"childTransformationsEnabled":{"x-samplevalue":true,"type":"boolean"},"deleted":{"x-samplevalue":false,"type":"boolean"},"hub":{"x-samplevalue":"general","type":"string"},"typeOauth":{"x-samplevalue":false,"type":"boolean"},"name":{"x-samplevalue":"dummy","type":"string"},"extendable":{"x-samplevalue":true,"type":"boolean"},"parameters":{"type":"array","items":{"$ref":"#/definitions/ElementInstancePostElementParameters"}}}},"ElementInstancePostElementResourcesResponse":{"type":"object","title":"response","properties":{"contentTypeAsString":{"x-samplevalue":"application/json","type":"string"},"contentType":{"x-samplevalue":"application/json","type":"string"}}},"ElementInstancePostConfiguration":{"type":"object","title":"configuration","properties":{"config_property_name_placeholder":{"x-samplevalue":"string","type":"string"}}},"ElementInstancePostElementResourcesParameters":{"title":"parameters","properties":{"vendorType":{"x-samplevalue":"query","type":"string"},"resourceId":{"x-samplevalue":571873,"format":"int32","type":"integer"},"dataType":{"x-samplevalue":"string","type":"string"},"converter":{"x-samplevalue":"toQueryParameters","type":"string"},"description":{"x-samplevalue":"The page number of resources to retrieve","type":"string"},"vendorDataType":{"x-samplevalue":"string","type":"string"},"updatedDate":{"x-samplevalue":"2021-02-12T03:04:25Z","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"},"source":{"x-samplevalue":"request","type":"string"},"vendorName":{"x-samplevalue":"page","type":"string"},"type":{"x-samplevalue":"query","type":"string"},"required":{"x-samplevalue":false,"type":"boolean"},"createdDate":{"x-samplevalue":"2021-02-12T03:04:18Z","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"},"name":{"x-samplevalue":"page","type":"string"},"id":{"x-samplevalue":1336324,"format":"int32","type":"integer"}},"type":"object"},"swaggerDocVersionsObject":{"title":"swaggerDocVersions","type":"object","properties":{"elementId":{"x-samplevalue":23,"format":"int32","type":"integer"},"createdDate":{"x-samplevalue":"2018-12-05T11:45:36Z","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"},"version":{"x-samplevalue":"1.0.0","type":"string"}}},"objectsMetadata":{"properties":{"fields":{"items":{"$ref":"#/definitions/objectsMetadataFields"},"type":"array"},"hasCustomFields":{"x-samplevalue":true,"type":"boolean"},"filterableJoins":{"x-samplevalue":["AND","OR"],"type":"array","items":{"type":"string"}}},"type":"object"},"picklistValuesListObject":{"title":"picklistValuesList","type":"object","properties":{"value":{"x-samplevalue":"Web","type":"string"}}},"methodListObject":{"title":"methodList","type":"object","properties":{"request":{"x-samplevalue":true,"type":"boolean"},"response":{"x-samplevalue":true,"type":"boolean"},"name":{"x-samplevalue":"GET","type":"string"}}},"objectsMetadataFields":{"properties":{"mask":{"type":"string"},"type":{"type":"string"},"vendorDisplayName":{"type":"string"},"vendorPath":{"type":"string"},"vendorReadOnly":{"type":"boolean"},"vendorRequired":{"type":"boolean"},"path":{"x-samplevalue":"AccountId","type":"string"},"picklistValues":{"type":"array","items":{"$ref":"#/definitions/picklistValuesListObject"}},"filterable":{"x-samplevalue":true,"type":"boolean"},"method":{"type":"array","items":{"$ref":"#/definitions/methodListObject"}},"filterableOperators":{"x-samplevalue":["=","!=",">",">=","<","<=","LIKE"],"type":"array","items":{"type":"string"}},"vendorNativeType":{"x-samplevalue":"string","type":"string"},"primaryKey":{"x-samplevalue":true,"type":"boolean"}},"type":"object"},"Operations":{"title":"Operations","type":"object","properties":{"operationId":{"type":"string"},"method":{"type":"string"},"path":{"type":"string"},"objectName":{"type":"string"}}},"Authentication":{"properties":{"type":{"description":"basic, oauth1, oauth2","type":"string"}},"type":"object"},"Configuration":{"properties":{"description":{"description":"The description of the configuration item.","type":"string"},"key":{"description":"The key of the configuration item (e.g. 'sfdc.instance.id' to identify a Salesforce.com instance ID).","type":"string"},"name":{"description":"The name of the configuration item.","type":"string"},"type":{"description":"The type of the configuration item.
value: A string value.
elementInstance: An element instance.","enum":["value","elementInstance"],"type":"string"}},"required":["name","key","type"],"type":"object"},"DefaultTransformations":{"properties":{"name":{"type":"string"},"vendorName":{"type":"string"}},"type":"object"},"ObjectMetadata":{"properties":{"objectName_placeholder":{"description":"Object metadata object name place holder","$ref":"#/definitions/ObjectMetadataFields"}},"type":"object"},"ObjectMetadataFields":{"properties":{"fields":{"items":{"$ref":"#/definitions/Field"},"type":"array"}},"type":"object"},"Field":{"properties":{"description":{"type":"string"},"id":{"type":"string"},"position":{"type":"string"},"required":{"type":"boolean"},"title":{"type":"string"},"type":{"type":"string"}},"type":"object"},"ConfigurationPropertyMap":{"properties":{"config_property_name_placeholder":{"description":"Configuration object name place holder","type":"string"}},"type":"object"},"CreateElement":{"properties":{"authentication":{"$ref":"#/definitions/Authentication"},"configuration":{"items":{"$ref":"#/definitions/Configuration"},"type":"array"},"description":{"type":"string"},"hub":{"type":"string"},"image":{"type":"string"},"name":{"type":"string"},"parameters":{"description":"These are parameters that are passed on every single API call for this element","items":{"$ref":"#/definitions/Parameter"},"type":"array"},"resources":{"items":{"$ref":"#/definitions/Resource"},"type":"array"}},"type":"object"},"DefaultParameter":{"properties":{"name":{"type":"string"},"type":{"description":"query, header, path, body, configuration, value","type":"string"},"vendorName":{"type":"string"},"vendorType":{"description":"query, header, path, body, configuration, value","type":"string"}},"type":"object"},"ElementByIdResourcesHooks":{"title":"hooks","properties":{"resourceId":{"x-samplevalue":12937,"format":"int32","type":"integer"},"isLegacy":{"x-samplevalue":false,"type":"boolean"},"contextParams":{"x-samplevalue":"request_vendor_body","type":"string"},"id":{"x-samplevalue":8565,"format":"int32","type":"integer"},"mimeType":{"x-samplevalue":"application/javascript","type":"string"},"type":{"x-samplevalue":"preRequest","type":"string"},"body":{"x-samplevalue":"if (request_vendor_body && !request_vendor_body.SyncToken) {\n let requestBody = JSON.parse(request_vendor_body);\n requestBody.SyncToken = \"0\";\n done({\n request_vendor_body: requestBody\n });\n}\n\ndone();","type":"string"}},"type":"object"},"ElementByIdParameters":{"title":"parameters","properties":{"vendorType":{"x-samplevalue":"no-op","type":"string"},"resourceId":{"x-samplevalue":15716,"format":"int32","type":"integer"},"createdDate":{"x-samplevalue":"2020-04-28T07:32:06Z","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"},"dataType":{"x-samplevalue":"integer","type":"string"},"name":{"x-samplevalue":"page","type":"string"},"description":{"x-samplevalue":"The page number of resources to retrieve","type":"string"},"vendorDataType":{"x-samplevalue":"integer","type":"string"},"id":{"x-samplevalue":37658,"format":"int32","type":"integer"},"source":{"x-samplevalue":"request","type":"string"},"vendorName":{"x-samplevalue":"page","type":"string"},"type":{"x-samplevalue":"query","type":"string"},"required":{"x-samplevalue":false,"type":"boolean"}},"type":"object"},"ElementByIdConfiguration":{"title":"configuration","properties":{"internal":{"x-samplevalue":true,"type":"boolean"},"companyConfig":{"x-samplevalue":false,"type":"boolean"},"defaultValue":{"x-samplevalue":"oauth2","type":"string"},"displayOrder":{"x-samplevalue":0,"format":"int32","type":"integer"},"description":{"x-samplevalue":"SFDC User Display Name","type":"string"},"active":{"x-samplevalue":false,"type":"boolean"},"isPrivate":{"x-samplevalue":false,"type":"boolean"},"type":{"x-samplevalue":"TEXTFIELD_128","type":"string"},"resellerConfig":{"x-samplevalue":false,"type":"boolean"},"required":{"x-samplevalue":false,"type":"boolean"},"groupName":{"x-samplevalue":"oauth2","type":"string"},"hideFromConsole":{"x-samplevalue":true,"type":"boolean"},"name":{"x-samplevalue":"User Display Name","type":"string"},"options":{"type":"array","items":{"$ref":"#/definitions/ElementByIdConfigurationOptions"}},"id":{"x-samplevalue":134,"format":"int32","type":"integer"},"groupControl":{"x-samplevalue":false,"type":"boolean"},"key":{"x-samplevalue":"sfdc.user.display.name","type":"string"}},"type":"object"},"ElementById":{"title":"ElementById","properties":{"version":{"x-samplevalue":"1.0.0","type":"string"},"private":{"x-samplevalue":false,"type":"boolean"},"configuration":{"type":"array","items":{"$ref":"#/definitions/ElementByIdConfiguration"}},"objects":{"type":"array","items":{"$ref":"#/definitions/ElementByIdObjects"}},"description":{"x-samplevalue":"Add a Salesforce Instance to connect your existing Salesforce account to the CRM Hub, allowing you to manage contacts, leads, accounts, opportunities etc. across multiple CRM Elements or your other Salesforce services. You will need your Salesforce account information to add an instance.","type":"string"},"cloneable":{"x-samplevalue":true,"type":"boolean"},"hookName":{"x-samplevalue":"Salesforcecom","type":"string"},"extended":{"x-samplevalue":false,"type":"boolean"},"bulkDownloadEnabled":{"x-samplevalue":true,"type":"boolean"},"useModelsForMetadata":{"x-samplevalue":true,"type":"boolean"},"paginatorVersion":{"x-samplevalue":"V2","type":"string"},"defaultTransformations":{"type":"array","items":{"$ref":"#/definitions/ElementByIdDefaultTransformations"}},"trialAccount":{"x-samplevalue":false,"type":"boolean"},"logo":{"x-samplevalue":"sfdc","type":"string"},"id":{"x-samplevalue":23,"format":"int32","type":"integer"},"hooks":{"type":"array","items":{"$ref":"#/definitions/ElementByIdHooks"}},"key":{"x-samplevalue":"sfdc","type":"string"},"beta":{"x-samplevalue":false,"type":"boolean"},"authentication":{"$ref":"#/definitions/ElementByIdAuthentication"},"bulkUploadEnabled":{"x-samplevalue":true,"type":"boolean"},"image":{"x-samplevalue":"elements/provider_sfdc.png","type":"string"},"signupURL":{"x-samplevalue":"https://developer.salesforce.com/en/signup","type":"string"},"active":{"x-samplevalue":true,"type":"boolean"},"resources":{"type":"array","items":{"$ref":"#/definitions/ElementByIdResources"}},"protocolType":{"x-samplevalue":"http","type":"string"},"transformationsEnabled":{"x-samplevalue":true,"type":"boolean"},"childTransformationsEnabled":{"x-samplevalue":true,"type":"boolean"},"deleted":{"x-samplevalue":false,"type":"boolean"},"hub":{"x-samplevalue":"crm","type":"string"},"typeOauth":{"x-samplevalue":true,"type":"boolean"},"configDescription":{"x-samplevalue":"If you do not have a Salesforce.com account, you can create one at Salesforce.com Signup","type":"string"},"name":{"x-samplevalue":"Salesforce Sales Cloud","type":"string"},"extendable":{"x-samplevalue":true,"type":"boolean"},"parameters":{"type":"array","items":{"$ref":"#/definitions/ElementByIdParameters"}}},"type":"object"},"ElementByIdObjects":{"title":"objects","properties":{"elementId":{"x-samplevalue":23,"format":"int32","type":"integer"},"metadataDiscovery":{"x-samplevalue":false,"type":"boolean"},"notes":{"x-samplevalue":"notes added","type":"string"},"customFields":{"x-samplevalue":false,"type":"boolean"},"eventsEnabled":{"x-samplevalue":false,"type":"boolean"},"eventCreatedSupported":{"x-samplevalue":false,"type":"boolean"},"nativeBulkUpload":{"x-samplevalue":false,"type":"boolean"},"description":{"x-samplevalue":"The binary data of the latest version of the Document or Attachment","type":"string"},"vendorEventTypes":{"x-samplevalue":"none","type":"string"},"tags":{"x-samplevalue":["abc"],"type":"array","items":{"type":"string"}},"ownerAccountId":{"x-samplevalue":1,"format":"int32","type":"integer"},"name":{"x-samplevalue":"filesVersionsLatestVersion","type":"string"},"operationsSupported":{"x-samplevalue":["unknown"],"type":"array","items":{"type":"string"}},"hulkDownloadEnabled":{"x-samplevalue":true,"type":"boolean"},"eventUpdatedSupported":{"x-samplevalue":false,"type":"boolean"},"isNestedObject":{"x-samplevalue":true,"type":"boolean"},"id":{"x-samplevalue":430,"format":"int32","type":"integer"},"nativeBulkDownload":{"x-samplevalue":false,"type":"boolean"},"migrated":{"x-samplevalue":false,"type":"boolean"},"hulkUploadEnabled":{"x-samplevalue":false,"type":"boolean"},"eventDeletedSupported":{"x-samplevalue":false,"type":"boolean"}},"type":"object"},"ElementByIdDefaultTransformations":{"title":"defaultTransformations","properties":{"name":{"x-samplevalue":"accounts","type":"string"},"vendorName":{"x-samplevalue":"Account","type":"string"}},"type":"object"},"ElementByIdResourcesParameters":{"title":"parameters","properties":{"vendorType":{"x-samplevalue":"no-op","type":"string"},"resourceId":{"x-samplevalue":15716,"format":"int32","type":"integer"},"createdDate":{"x-samplevalue":"2020-04-28T07:32:06Z","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"},"dataType":{"x-samplevalue":"integer","type":"string"},"name":{"x-samplevalue":"page","type":"string"},"description":{"x-samplevalue":"The page number of resources to retrieve","type":"string"},"vendorDataType":{"x-samplevalue":"integer","type":"string"},"id":{"x-samplevalue":37658,"format":"int32","type":"integer"},"source":{"x-samplevalue":"request","type":"string"},"vendorName":{"x-samplevalue":"page","type":"string"},"type":{"x-samplevalue":"query","type":"string"},"required":{"x-samplevalue":false,"type":"boolean"}},"type":"object"},"ElementByIdHooks":{"title":"hooks","properties":{"resourceId":{"x-samplevalue":12937,"format":"int32","type":"integer"},"isLegacy":{"x-samplevalue":false,"type":"boolean"},"contextParams":{"x-samplevalue":"request_vendor_body","type":"string"},"id":{"x-samplevalue":8565,"format":"int32","type":"integer"},"mimeType":{"x-samplevalue":"application/javascript","type":"string"},"type":{"x-samplevalue":"preRequest","type":"string"},"body":{"x-samplevalue":"if (request_vendor_body && !request_vendor_body.SyncToken) {\n let requestBody = JSON.parse(request_vendor_body);\n requestBody.SyncToken = \"0\";\n done({\n request_vendor_body: requestBody\n });\n}\n\ndone();","type":"string"}},"type":"object"},"ElementByIdConfigurationOptions":{"title":"options","properties":{"description":{"x-samplevalue":"Polling Event Type","type":"string"},"value":{"x-samplevalue":"polling","type":"string"}},"type":"object"},"ElementByIdResources":{"title":"resources","properties":{"method":{"x-samplevalue":"GET","type":"string"},"kind":{"x-samplevalue":"java","type":"string"},"description":{"x-samplevalue":"Search for query","type":"string"},"updatedDate":{"x-samplevalue":"2020-04-28T07:32:06Z","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"},"type":{"x-samplevalue":"api","type":"string"},"path":{"x-samplevalue":"/hubs/crm/query","type":"string"},"createdDate":{"x-samplevalue":"2020-04-28T07:32:06Z","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"},"vendorMethod":{"x-samplevalue":"GET","type":"string"},"response":{"$ref":"#/definitions/ElementByIdResourcesResponse"},"ownerAccountId":{"x-samplevalue":1,"format":"int32","type":"integer"},"tryitoutDisable":{"x-samplevalue":false,"type":"boolean"},"id":{"x-samplevalue":15716,"format":"int32","type":"integer"},"parameters":{"type":"array","items":{"$ref":"#/definitions/ElementByIdResourcesParameters"}},"hooks":{"type":"array","items":{"$ref":"#/definitions/ElementByIdResourcesHooks"}}},"type":"object"},"ElementByIdAuthentication":{"type":"object","title":"authentication","properties":{"type":{"x-samplevalue":"oauth2","type":"string"}}},"ElementByIdResourcesResponse":{"type":"object","title":"response","properties":{"contentTypeAsString":{"x-samplevalue":"application/json","type":"string"},"contentType":{"x-samplevalue":"application/json","type":"string"}}},"Element":{"properties":{"active":{"type":"boolean"},"authenticationType":{"type":"string"},"configDescription":{"type":"string"},"createdDate":{"type":"number"},"deleted":{"type":"boolean"},"description":{"type":"string"},"existingAccountDescription":{"type":"string"},"id":{"type":"number"},"image":{"type":"string"},"key":{"type":"string"},"name":{"type":"string"},"signupURL":{"type":"string"},"trialAccount":{"type":"boolean"},"trialAccountDescription":{"type":"string"},"typeOauth":{"type":"boolean"},"updatedDate":{"type":"number"}},"type":"object"},"ElementConfig":{"properties":{"active":{"type":"boolean"},"companyConfig":{"type":"boolean"},"configDataType":{"type":"string"},"defaultValue":{"type":"string"},"description":{"type":"string"},"internal":{"type":"boolean"},"key":{"type":"string"},"mandatory":{"type":"boolean"},"name":{"type":"string"},"resellerConfig":{"type":"boolean"}},"type":"object"},"ElementConfigs":{"properties":{"configuration":{"items":{"$ref":"#/definitions/ElementConfig"},"type":"array"},"providerData":{"items":{"$ref":"#/definitions/ElementConfig"},"type":"array"}},"type":"object"},"ElementInstanceElementObjectMetadataTime-Activity":{"type":"object","title":"Time-Activity","properties":{"fields":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataTime-ActivityFields"}}}},"ElementInstanceElementObjectMetadataPaymentFields":{"title":"fields","properties":{"type":{"x-samplevalue":"string","type":"string"},"vendorPath":{"x-samplevalue":"debitCardIssueNo","type":"string"}},"type":"object"},"ElementInstanceElementObjectMetadataOpportunityFields":{"title":"fields","properties":{"type":{"x-samplevalue":"number","type":"string"},"vendorPath":{"x-samplevalue":"estGrossProfitPercent","type":"string"}},"type":"object"},"ElementInstanceElementDefaultTransformations":{"title":"defaultTransformations","properties":{"name":{"x-samplevalue":"vendor-categories","type":"string"},"vendorName":{"x-samplevalue":"VendorCategory","type":"string"}},"type":"object"},"ElementInstanceElementObjectMetadataFile":{"type":"object","title":"File","properties":{"fields":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataFileFields"}}}},"ElementInstanceElementObjectMetadataTax-Code":{"type":"object","title":"Tax-Code","properties":{"fields":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataTax-CodeFields"}}}},"ElementInstanceElementObjectMetadataTask":{"type":"object","title":"Task","properties":{"fields":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataTaskFields"}}}},"ElementInstanceElementObjectMetadataVendor-PaymentFields":{"title":"fields","properties":{"type":{"x-samplevalue":"string","type":"string"},"vendorPath":{"x-samplevalue":"tranId","type":"string"}},"type":"object"},"ElementInstanceElementObjectMetadataFileFields":{"title":"fields","properties":{"type":{"x-samplevalue":"string","type":"string"},"vendorPath":{"x-samplevalue":"_class","type":"string"},"mask":{"x-samplevalue":"milliseconds","type":"string"}},"type":"object"},"ElementInstanceElementObjectMetadataPayment-Method":{"type":"object","title":"Payment-Method","properties":{"fields":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataPayment-MethodFields"}}}},"ElementInstanceElementObjectMetadataAccountFields":{"title":"fields","properties":{"type":{"x-samplevalue":"string","type":"string"},"vendorPath":{"x-samplevalue":"parent.internalId","type":"string"}},"type":"object"},"ElementInstanceElementObjectMetadataFolderFields":{"title":"fields","properties":{"type":{"x-samplevalue":"string","type":"string"},"vendorPath":{"x-samplevalue":"_class.externalId","type":"string"}},"type":"object"},"ElementInstanceElementObjectMetadataVendorCredit":{"type":"object","title":"VendorCredit","properties":{"fields":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataVendorCreditFields"}}}},"ElementInstanceElementObjectMetadataProspectFields":{"title":"fields","properties":{"type":{"x-samplevalue":"string","type":"string"},"vendorPath":{"x-samplevalue":"parent.internalId","type":"string"}},"type":"object"},"ElementInstanceElementObjectMetadataCustomer":{"type":"object","title":"Customer","properties":{"fields":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataCustomerFields"}}}},"ElementInstanceElementObjectMetadataVendor-Payment":{"type":"object","title":"Vendor-Payment","properties":{"fields":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataVendor-PaymentFields"}}}},"ElementInstanceElementObjectMetadataJobFields":{"title":"fields","properties":{"type":{"x-samplevalue":"string","type":"string"},"vendorPath":{"x-samplevalue":"accountNumber","type":"string"}},"type":"object"},"ElementInstanceElementObjectMetadataVendor":{"type":"object","title":"Vendor","properties":{"fields":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataVendorFields"}}}},"ElementInstanceElementObjectMetadataEstimate":{"type":"object","title":"Estimate","properties":{"fields":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataEstimateFields"}}}},"ElementInstanceElementObjectMetadataInvoiceFields":{"title":"fields","properties":{"type":{"x-samplevalue":"string","type":"string"},"vendorPath":{"x-samplevalue":"discountRate","type":"string"}},"type":"object"},"ElementInstanceElementObjectMetadataTime-ActivityFields":{"title":"fields","properties":{"type":{"x-samplevalue":"string","type":"string"},"vendorPath":{"x-samplevalue":"memo","type":"string"}},"type":"object"},"ElementInstanceElementObjectMetadataLedger-AccountFields":{"title":"fields","properties":{"type":{"x-samplevalue":"string","type":"string"},"vendorPath":{"x-samplevalue":"parent.internalId","type":"string"}},"type":"object"},"ElementInstanceElementObjectMetadataAccountingPeriod":{"type":"object","title":"AccountingPeriod","properties":{"fields":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataAccountingPeriodFields"}}}},"ElementInstanceElementObjectMetadataTransactionSummary":{"type":"object","title":"TransactionSummary","properties":{"fields":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataTransactionSummaryFields"}}}},"ElementInstanceElementObjectMetadataContactFields":{"title":"fields","properties":{"type":{"x-samplevalue":"string","type":"string"},"vendorPath":{"x-samplevalue":"lastName","type":"string"}},"type":"object"},"ElementInstanceElementObjectMetadataCustomerFields":{"title":"fields","properties":{"type":{"x-samplevalue":"string","type":"string"},"vendorPath":{"x-samplevalue":"parent.internalId","type":"string"}},"type":"object"},"ElementInstanceElementObjectMetadataLead":{"type":"object","title":"Lead","properties":{"fields":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataLeadFields"}}}},"ElementInstanceElementObjectMetadataCredit-TermFields":{"title":"fields","properties":{"type":{"x-samplevalue":"number","type":"string"},"vendorPath":{"x-samplevalue":"discountPercent","type":"string"}},"type":"object"},"ElementInstanceElementObjectMetadataTransactionSummaryFields":{"title":"fields","properties":{"type":{"x-samplevalue":"string","type":"string"},"vendorPath":{"x-samplevalue":"_class.externalId","type":"string"}},"type":"object"},"ElementInstanceElementObjectMetadataEstimateFields":{"title":"fields","properties":{"type":{"x-samplevalue":"string","type":"string"},"vendorPath":{"x-samplevalue":"discountRate","type":"string"}},"type":"object"},"ElementInstanceElementObjectMetadataTax-RateFields":{"title":"fields","properties":{"type":{"x-samplevalue":"string","type":"string"},"vendorPath":{"x-samplevalue":"zip","type":"string"}},"type":"object"},"ElementInstanceElementObjectMetadataPurchase-OrderFields":{"title":"fields","properties":{"type":{"x-samplevalue":"date","type":"string"},"vendorPath":{"x-samplevalue":"dueDate","type":"string"}},"type":"object"},"ElementInstanceElementObjectMetadataCheck":{"type":"object","title":"Check","properties":{"fields":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataCheckFields"}}}},"ElementInstanceElementObjectMetadataAccountingPeriodFields":{"title":"fields","properties":{"type":{"x-samplevalue":"boolean","type":"string"},"vendorPath":{"x-samplevalue":"allLocked","type":"string"},"mask":{"x-samplevalue":"milliseconds","type":"string"}},"type":"object"},"ElementInstanceElementObjectMetadataCheckFields":{"title":"fields","properties":{"type":{"x-samplevalue":"string","type":"string"},"vendorPath":{"x-samplevalue":"_class.externalId","type":"string"},"mask":{"x-samplevalue":"milliseconds","type":"string"}},"type":"object"},"ElementInstanceElementObjectMetadataPhoneCallFields":{"title":"fields","properties":{"type":{"x-samplevalue":"boolean","type":"string"},"vendorPath":{"x-samplevalue":"accessLevel","type":"string"},"mask":{"x-samplevalue":"milliseconds","type":"string"}},"type":"object"},"ElementInstanceElementObjectMetadata":{"type":"object","title":"objectMetadata","properties":{"Account":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataAccount"},"Task":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataTask"},"Estimate":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataEstimate"},"Invoice":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataInvoice"},"Customer":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataCustomer"},"Credit-Term":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataCredit-Term"},"Tax-Rate":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataTax-Rate"},"Check":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataCheck"},"Product":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataProduct"},"Folder":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataFolder"},"Case":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataCase"},"Ledger-Account":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataLedger-Account"},"Payment-Method":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataPayment-Method"},"Purchase-Order":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataPurchase-Order"},"Opportunity":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataOpportunity"},"PhoneCall":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataPhoneCall"},"Lead":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataLead"},"Vendor-Payment":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataVendor-Payment"},"Journal-Entry":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataJournal-Entry"},"Job":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataJob"},"VendorCredit":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataVendorCredit"},"AccountingPeriod":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataAccountingPeriod"},"Vendor":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataVendor"},"Time-Activity":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataTime-Activity"},"Contact":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataContact"},"Tax-Code":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataTax-Code"},"Payment":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataPayment"},"Employee":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataEmployee"},"Bill":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataBill"},"CustomField":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataCustomField"},"Prospect":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataProspect"},"File":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataFile"},"TransactionSummary":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataTransactionSummary"}}},"ElementInstanceElementObjectMetadataLeadFields":{"title":"fields","properties":{"type":{"x-samplevalue":"string","type":"string"},"vendorPath":{"x-samplevalue":"parent.internalId","type":"string"}},"type":"object"},"ElementInstanceElementObjectMetadataContact":{"type":"object","title":"Contact","properties":{"fields":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataContactFields"}}}},"ElementInstanceElementObjectMetadataFolder":{"type":"object","title":"Folder","properties":{"fields":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataFolderFields"}}}},"ElementInstanceElementObjectMetadataJob":{"type":"object","title":"Job","properties":{"fields":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataJobFields"}}}},"ElementInstanceElementObjectMetadataAccount":{"type":"object","title":"Account","properties":{"fields":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataAccountFields"}}}},"ElementInstanceElementObjectMetadataCase":{"type":"object","title":"Case","properties":{"fields":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataCaseFields"}}}},"ElementInstanceElementObjectMetadataLedger-Account":{"type":"object","title":"Ledger-Account","properties":{"fields":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataLedger-AccountFields"}}}},"ElementInstanceElementObjectMetadataPayment":{"type":"object","title":"Payment","properties":{"fields":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataPaymentFields"}}}},"ElementInstanceElementObjectMetadataOpportunity":{"type":"object","title":"Opportunity","properties":{"fields":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataOpportunityFields"}}}},"ElementInstanceElementObjectMetadataProduct":{"type":"object","title":"Product","properties":{"fields":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataProductFields"}}}},"ElementInstanceElementObjectMetadataPayment-MethodFields":{"title":"fields","properties":{"type":{"x-samplevalue":"string","type":"string"},"vendorPath":{"x-samplevalue":"visualsList.paymentMethodVisuals[*].flags","type":"string"}},"type":"object"},"ElementInstanceElementObjectMetadataCustomFieldFields":{"title":"fields","properties":{"type":{"x-samplevalue":"string","type":"string"},"vendorPath":{"x-samplevalue":"externalId","type":"string"}},"type":"object"},"ElementInstanceElementObjectMetadataTaskFields":{"title":"fields","properties":{"type":{"x-samplevalue":"string","type":"string"},"vendorPath":{"x-samplevalue":"supportCase.internalId","type":"string"}},"type":"object"},"ElementInstanceElementObjectMetadataVendorCreditFields":{"title":"fields","properties":{"type":{"x-samplevalue":"string","type":"string"},"vendorPath":{"x-samplevalue":"_class.externalId","type":"string"},"mask":{"x-samplevalue":"milliseconds","type":"string"}},"type":"object"},"ElementInstanceElementObjectMetadataCredit-Term":{"type":"object","title":"Credit-Term","properties":{"fields":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataCredit-TermFields"}}}},"ElementInstanceElementObjectMetadataJournal-Entry":{"type":"object","title":"Journal-Entry","properties":{"fields":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataJournal-EntryFields"}}}},"ElementInstanceElementObjectMetadataProspect":{"type":"object","title":"Prospect","properties":{"fields":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataProspectFields"}}}},"ElementInstanceElementObjectMetadataTax-Rate":{"type":"object","title":"Tax-Rate","properties":{"fields":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataTax-RateFields"}}}},"ElementInstanceElementObjectMetadataProductFields":{"title":"fields","properties":{"type":{"x-samplevalue":"string","type":"string"},"vendorPath":{"x-samplevalue":"parent.internalId","type":"string"}},"type":"object"},"ElementInstanceElementObjectMetadataEmployee":{"type":"object","title":"Employee","properties":{"fields":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataEmployeeFields"}}}},"ElementInstanceElement":{"type":"object","title":"element","properties":{"version":{"x-samplevalue":"1.0.0","type":"string"},"bulkUploadEnabled":{"x-samplevalue":true,"type":"boolean"},"image":{"x-samplevalue":"elements/custom-element-default-logo.png","type":"string"},"private":{"x-samplevalue":false,"type":"boolean"},"description":{"x-samplevalue":"Add a Zoho CRM V2 Instance to connect your existing Zoho CRM account to the CRM Hub, allowing you to manage contacts, leads, accounts, opportunities etc. across multiple CRM Elements. You will need your Zoho CRM account information to add an instance.","type":"string"},"active":{"x-samplevalue":true,"type":"boolean"},"protocolType":{"x-samplevalue":"http","type":"string"},"cloneable":{"x-samplevalue":true,"type":"boolean"},"transformationsEnabled":{"x-samplevalue":true,"type":"boolean"},"childTransformationsEnabled":{"x-samplevalue":true,"type":"boolean"},"bulkDownloadEnabled":{"x-samplevalue":true,"type":"boolean"},"deleted":{"x-samplevalue":false,"type":"boolean"},"hub":{"x-samplevalue":"crm","type":"string"},"useModelsForMetadata":{"x-samplevalue":true,"type":"boolean"},"typeOauth":{"x-samplevalue":false,"type":"boolean"},"paginatorVersion":{"x-samplevalue":"V2","type":"string"},"name":{"x-samplevalue":"Zoho Crm V2","type":"string"},"trialAccount":{"x-samplevalue":false,"type":"boolean"},"logo":{"x-samplevalue":"zohocrmv2","type":"string"},"id":{"x-samplevalue":19804,"format":"int32","type":"integer"},"extendable":{"x-samplevalue":true,"type":"boolean"},"key":{"x-samplevalue":"zohocrmv2","type":"string"},"beta":{"x-samplevalue":false,"type":"boolean"},"authentication":{"$ref":"#/definitions/ElementInstanceElementAuthentication"}}},"ElementInstanceElementObjectMetadataTax-CodeFields":{"title":"fields","properties":{"type":{"x-samplevalue":"string","type":"string"},"vendorPath":{"x-samplevalue":"internalId","type":"string"}},"type":"object"},"ElementInstanceElementObjectMetadataPurchase-Order":{"type":"object","title":"Purchase-Order","properties":{"fields":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataPurchase-OrderFields"}}}},"ElementInstanceElementObjectMetadataBill":{"type":"object","title":"Bill","properties":{"fields":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataBillFields"}}}},"ElementInstanceElementObjectMetadataBillFields":{"title":"fields","properties":{"type":{"x-samplevalue":"string","type":"string"},"vendorPath":{"x-samplevalue":"_class.externalId","type":"string"}},"type":"object"},"ElementInstanceElementObjectMetadataPhoneCall":{"type":"object","title":"PhoneCall","properties":{"fields":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataPhoneCallFields"}}}},"ElementInstanceElementObjectMetadataEmployeeFields":{"title":"fields","properties":{"type":{"x-samplevalue":"boolean","type":"string"},"vendorPath":{"x-samplevalue":"eligibleForCommission","type":"string"}},"type":"object"},"ElementInstanceElementObjectMetadataCustomField":{"type":"object","title":"CustomField","properties":{"fields":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataCustomFieldFields"}}}},"ElementInstanceElementObjectMetadataInvoice":{"type":"object","title":"Invoice","properties":{"fields":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceElementObjectMetadataInvoiceFields"}}}},"ElementInstanceElementAuthentication":{"type":"object","title":"authentication","properties":{"type":{"x-samplevalue":"oauth2","type":"string"}}},"ElementInstanceElementObjectMetadataCaseFields":{"title":"fields","properties":{"type":{"x-samplevalue":"date","type":"string"},"vendorPath":{"x-samplevalue":"endDate","type":"string"}},"type":"object"},"ElementInstanceElementObjectMetadataJournal-EntryFields":{"title":"fields","properties":{"type":{"x-samplevalue":"string","type":"string"},"vendorPath":{"x-samplevalue":"tranId","type":"string"}},"type":"object"},"ElementInstanceElementObjectMetadataVendorFields":{"title":"fields","properties":{"type":{"x-samplevalue":"boolean","type":"string"},"vendorPath":{"x-samplevalue":"eligibleForCommission","type":"string"}},"type":"object"},"ElementInstance":{"properties":{"cacheTimeToLive":{"type":"integer"},"cachingEnabled":{"type":"boolean"},"disabled":{"type":"boolean"},"element":{"$ref":"#/definitions/Element"},"id":{"type":"number"},"maxCacheSize":{"type":"number"},"name":{"type":"string"},"token":{},"valid":{"type":"boolean"}},"type":"object"},"ElementMetadata":{"title":"ElementMetadata","properties":{"defaultAuthentication":{"x-samplevalue":"oauth2","type":"string"},"name":{"x-samplevalue":"HubSpot CRM","type":"string"},"displayOrder":{"x-samplevalue":100,"format":"int32","type":"integer"},"active":{"x-samplevalue":true,"type":"boolean"},"description":{"x-samplevalue":"HubSpot is an inbound marketing software platform that helps companies attract visitors, convert leads, and close customers.","type":"string"},"id":{"x-samplevalue":81,"format":"int32","type":"integer"},"key":{"x-samplevalue":"hubspotcrm","type":"string"},"beta":{"x-samplevalue":false,"type":"boolean"},"events":{"x-samplevalue":["polling","webhook"],"type":"array","items":{"type":"string"}},"extended":{"x-samplevalue":false,"type":"boolean"},"captured":{"x-samplevalue":false,"type":"boolean"},"private":{"x-samplevalue":false,"type":"boolean"}},"type":"object"},"EventMetadata":{"properties":{"methods":{"items":{"type":"string"},"type":"array"},"polling":{"$ref":"#/definitions/EventMethodMetadata"},"supported":{"type":"boolean"},"webhook":{"$ref":"#/definitions/EventMethodMetadata"}},"type":"object"},"EventMethodMetadata":{"properties":{"resourceName_placeholder":{"description":"Event method object name place holder","$ref":"#/definitions/EventResourceMetadata"}},"type":"object"},"EventResourceMetadata":{"properties":{"eventTypes":{"items":{"type":"string"},"type":"array"},"pollUrl":{"type":"string"}},"type":"object"},"Model":{"properties":{"name":{"type":"string"},"swagger":{"type":"object"}},"type":"object"},"OAuthInfo":{"properties":{"apiKey":{"type":"string"},"apiSecret":{"description":"The OAuth API secret","type":"string"},"callbackUrl":{"description":"The OAuth callback URL","type":"string"},"scope":{"description":"The OAuth scope","type":"string"},"siteAddress":{"description":"The site address","type":"string"},"state":{"description":"The OAuth state","type":"string"},"isOAuthProxy":{"description":"The callback URL is proxy or not, default value is false","type":"boolean"},"oauthProxyName":{"description":"The name of the OAuth proxy, if applicable","type":"string"},"requestToken":{"description":"The OAuth1 Request Token","type":"string"}},"required":["callbackurl"],"type":"object"},"OAuthRedirect":{"properties":{"element":{"type":"string"},"oauthUrl":{"type":"string"}},"type":"object"},"OAuthToken":{"properties":{"secret":{"type":"string"},"token":{"type":"string"}},"type":"object"},"Parameter":{"properties":{"dataType":{"type":"string"},"description":{"type":"string"},"name":{"type":"string"},"required":{"type":"boolean"},"type":{"description":"query, header, path, body, configuration, value, multipart","type":"string"},"vendorDataType":{"type":"string"},"vendorName":{"type":"string"},"vendorType":{"description":"query, header, path, body, configuration, value, multipart","type":"string"}},"type":"object"},"ProviderPropertyMap":{"properties":{"provider_property_name_placeholder":{"description":"provider property object name place holder","type":"string"}},"type":"object"},"User":{"properties":{"accountId":{"type":"string"},"apiKeys":{"$ref":"#/definitions/Link"},"applications":{"$ref":"#/definitions/Link"},"createdAt":{"type":"string"},"customData":{"$ref":"#/definitions/Link"},"directory":{"$ref":"#/definitions/Link"},"email":{"type":"string"},"emailVerificationToken":{"type":"string"},"fullName":{"type":"string"},"givenName":{"type":"string"},"groupMemberships":{"$ref":"#/definitions/Link"},"groups":{"$ref":"#/definitions/Link"},"href":{"type":"string"},"modifiedAt":{"type":"string"},"providerData":{"$ref":"#/definitions/Link"},"status":{"type":"string"},"surname":{"type":"string"},"tenant":{"$ref":"#/definitions/Link"},"username":{"type":"string"}},"type":"object"},"Resource":{"properties":{"description":{"type":"string"},"operationId":{"type":"string"},"method":{"type":"string"},"parameters":{"items":{"$ref":"#/definitions/Parameter"},"type":"array"},"path":{"type":"string"},"vendorMethod":{"type":"string"},"vendorPath":{"type":"string"},"rootKey":{"type":"string","description":"A root key consists of response rootkey and request rootkey in the format requestKey|responseKey"},"paginationType":{"type":"string","description":"Pagination type if supported by the resource, VENDOR_NOT_SUPPORTED or VENDOR_SUPPORTED"},"nextResource":{"type":"string","description":"Next resource to execute in the chain, should be in the format method:resourcepath"},"object":{"$ref":"#/definitions/ResourceObject"}},"type":"object"},"swagger200":{"x-has-customfields":false,"type":"object","title":"200","properties":{"schema":{"$ref":"#/definitions/swaggerschema"},"description":{"x-samplevalue":"OK - Everything worked as expected","type":"string"}}},"swagger400":{"x-has-customfields":false,"type":"object","title":"400","properties":{"description":{"x-samplevalue":"Bad Request - Often due to a missing request parameter","type":"string"}}},"swagger401":{"x-has-customfields":false,"type":"object","title":"401","properties":{"description":{"x-samplevalue":"Unauthorized - An invalid element token, user secret and/or org secret provided","type":"string"}}},"swagger403":{"x-has-customfields":false,"type":"object","title":"403","properties":{"description":{"x-samplevalue":"Forbidden - Access to the resource by the provider is forbidden","type":"string"}}},"swagger404":{"x-has-customfields":false,"type":"object","title":"404","properties":{"description":{"x-samplevalue":"Not found - The requested resource is not found","type":"string"}}},"swagger405":{"x-has-customfields":false,"type":"object","title":"405","properties":{"description":{"x-samplevalue":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected","type":"string"}}},"swagger406":{"x-has-customfields":false,"type":"object","title":"406","properties":{"description":{"x-samplevalue":"Not acceptable - The response content type does not match the 'Accept' header value","type":"string"}}},"swagger409":{"x-has-customfields":false,"type":"object","title":"409","properties":{"description":{"x-samplevalue":"Conflict - If a resource being created already exists","type":"string"}}},"swagger415":{"x-has-customfields":false,"type":"object","title":"415","properties":{"description":{"x-samplevalue":"Unsupported media type - The server cannot handle the requested Content-Type","type":"string"}}},"swagger500":{"x-has-customfields":false,"type":"object","title":"500","properties":{"description":{"x-samplevalue":"Server error - Something went wrong on the Cloud Elements server","type":"string"}}},"swagger502":{"x-has-customfields":false,"type":"object","title":"502","properties":{"description":{"x-samplevalue":"Provider server error - Something went wrong on the Provider or Endpoint's server","type":"string"}}},"swaggerschema":{"x-has-customfields":false,"type":"object","title":"schema","properties":{"$ref":{"x-samplevalue":"#/definitions/Contact-POST-Response","type":"string"}}},"swaggerpost":{"x-has-customfields":false,"type":"object","title":"post","properties":{"summary":{"x-samplevalue":"Create a new contact in the CRM service. Contact creation will flow through Cloud Elements to your CRM service. With the exception of the 'id' field, the required fields indicated in the 'Contact' model are those required to create a new contact.","type":"string"},"operationId":{"x-samplevalue":"createContact","type":"string"},"responses":{"$ref":"#/definitions/swaggerresponses"},"parameters":{"type":"array","items":{"$ref":"#/definitions/swaggerparameters"}},"tags":{"x-samplevalue":["contacts"],"type":"array","items":{"type":"string"}}}},"swaggercontact":{"x-has-customfields":false,"type":"object","title":"contact","properties":{"email":{"x-samplevalue":"support@cloud-elements.com","type":"string"}}},"swaggerparametersschema":{"x-has-customfields":false,"type":"object","title":"schema","properties":{"$ref":{"x-samplevalue":"#/definitions/Contact","type":"string"}}},"swaggerdefinitions":{"x-has-customfields":false,"type":"object","title":"definitions","properties":{"definition-name":{"$ref":"#/definitions/swaggerdefinition-name"}}},"swaggerinfo":{"x-has-customfields":false,"type":"object","title":"info","properties":{"contact":{"$ref":"#/definitions/swaggercontact"},"title":{"x-samplevalue":"hubspotcrm","type":"string"},"version":{"x-samplevalue":"api-v2","type":"string"},"x-element-name":{"x-samplevalue":"Salesforce Sales Cloud","type":"string"},"x-element-hub":{"x-samplevalue":"crm","type":"string"},"x-element-key":{"x-samplevalue":"sfdc","type":"string"},"x-element-id":{"x-samplevalue":23,"format":"int32","type":"integer"}}},"swaggerdefinition-property":{"x-has-customfields":false,"type":"object","title":"#/definitions/definition-property","properties":{"type":{"x-samplevalue":"string","type":"string"}}},"swaggerDocs":{"x-has-customfields":false,"title":"swaggerDocs","properties":{"basePath":{"x-samplevalue":"/elements/api-v2/hubs/crm","type":"string"},"paths":{"$ref":"#/definitions/swaggerpaths"},"host":{"x-samplevalue":"localhost:5050","type":"string"},"schemes":{"x-samplevalue":["http"],"type":"array","items":{"type":"string"}},"definitions":{"$ref":"#/definitions/swaggerdefinitions"},"swagger":{"x-samplevalue":"2.0","type":"string"},"info":{"$ref":"#/definitions/swaggerinfo"},"tags":{"type":"array","items":{"$ref":"#/definitions/swaggertags"}}},"type":"object"},"swaggertags":{"x-has-customfields":false,"title":"tags","properties":{"name":{"x-samplevalue":"contacts","type":"string"}},"type":"object"},"swaggerpaths":{"x-has-customfields":false,"type":"object","title":"paths","properties":{"/contacts":{"$ref":"#/definitions/swagger-contacts-path"}}},"swaggerresponses":{"x-has-customfields":false,"type":"object","title":"responses","properties":{"200":{"$ref":"#/definitions/swagger200"},"400":{"$ref":"#/definitions/swagger400"},"401":{"$ref":"#/definitions/swagger401"},"403":{"$ref":"#/definitions/swagger403"},"404":{"$ref":"#/definitions/swagger404"},"405":{"$ref":"#/definitions/swagger405"},"406":{"$ref":"#/definitions/swagger406"},"409":{"$ref":"#/definitions/swagger409"},"415":{"$ref":"#/definitions/swagger415"},"500":{"$ref":"#/definitions/swagger500"},"502":{"$ref":"#/definitions/swagger502"}}},"swaggerdefinition-name":{"x-has-customfields":false,"type":"object","title":"definition-name","properties":{"properties":{"$ref":"#/definitions/swaggerproperties"}}},"swaggerparameters":{"x-has-customfields":false,"title":"parameters","properties":{"schema":{"$ref":"#/definitions/swaggerparametersschema"},"in":{"x-samplevalue":"header","type":"string"},"name":{"x-samplevalue":"Authorization","type":"string"},"description":{"x-samplevalue":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","type":"string"},"type":{"x-samplevalue":"string","type":"string"},"required":{"x-samplevalue":true,"type":"boolean"}},"type":"object"},"swaggerproperties":{"x-has-customfields":false,"type":"object","title":"properties","properties":{"definition-property":{"$ref":"#/definitions/swaggerdefinition-property"},"x-vendor-objectname":{"x-samplevalue":"Account","type":"string"},"x-has-customfields":{"x-samplevalue":true,"type":"boolean"},"x-primary-key":{"x-samplevalue":["Id"],"type":"array","items":{"type":"string"}},"type":{"x-samplevalue":"object","type":"string"},"required":{"x-samplevalue":["Name"],"type":"array","items":{"type":"string"}}}},"swagger-contacts-path":{"x-has-customfields":false,"type":"object","title":"/contacts","properties":{"post":{"$ref":"#/definitions/swaggerpost"}}},"BulkStatus":{"description":"Status of the bulk upload.","properties":{"batchId":{"description":"Contact/Leads loaded","type":"number"},"message":{"type":"string"},"numOfLeadsProcessed":{"description":"Contact/Leads loaded","type":"number"},"numOfRowsFailed":{"description":"Failed count","type":"number"},"numOfRowsWithWarning":{"description":"Contact/Leads that had warnings","type":"number"},"status":{"description":"Status of the bulk job","type":"string"}}},"BulkLoad":{"description":"BulkLoad response of bulk upload.","properties":{"id":{"description":"Id of the bulk job","type":"number"},"status":{"description":"Status of the bulk job","type":"string"}}},"BulkQuery":{"description":"BulkLoad response of bulk download.","properties":{"id":{"description":"Id of the bulk job","type":"number"},"status":{"description":"Status of the bulk job","type":"string"}}},"Pong":{"properties":{"dateTime":{"format":"date-time","type":"string"},"endpoint":{"type":"string"}}},"ModelDate":{"properties":{"value":{"type":"string"}}},"ResourceField":{"properties":{"request":{"type":"boolean"},"response":{"type":"boolean"},"required":{"type":"boolean"},"id":{"type":"integer"},"name":{"type":"string"},"displayName":{"type":"string"},"sampleValue":{"type":"string"},"description":{"type":"string"},"objectId":{"type":"integer"},"type":{"type":"string"},"format":{"type":"string"},"mask":{"type":"string"},"ownerAccountId":{"type":"integer"},"primaryKey":{"type":"boolean"},"readOnly":{"type":"boolean"},"hidden":{"type":"boolean"},"createdDate":{"type":"string"},"updatedDate":{"type":"string"},"referenceObjectId":{"type":"integer"},"reference":{"$ref":"#/definitions/ResourceObject"}},"type":"object"},"Hook":{"properties":{"body":{"type":"string"},"elementId":{"type":"number"},"id":{"type":"number"},"isLegacy":{"type":"boolean"},"mimeType":{"type":"string"},"type":{"type":"string"}},"type":"object"},"Object":{"description":"A custom or standard object. With the exception of the 'id' field, the required fields indicated are those required to create a new object. For other object operations, the required fields will be a subset of these fields. There will be other fields associated with an Object, which are not all described here.","properties":{"id":{"type":"string"}},"required":["id"],"type":"object"},"ResourceObject":{"properties":{"name":{"type":"string"},"primaryKeyName":{"type":"string"},"createdDateName":{"type":"string"},"createdDateFormat":{"type":"string"},"updatedDateName":{"type":"string"},"updatedDateFormat":{"type":"string"},"ownerAccountId":{"type":"integer"},"bulkDownloadEnabled":{"type":"boolean"},"bulkUploadEnabled":{"type":"boolean"},"eventsEnabled":{"type":"boolean"},"fields":{"items":{"$ref":"#/definitions/ResourceField"},"type":"array"}},"type":"object"},"ElementInstanceUser":{"type":"object","title":"user","properties":{"firstName":{"x-samplevalue":"Rahul","type":"string"},"lastName":{"x-samplevalue":"Gupta","type":"string"},"emailAddress":{"x-samplevalue":"rahul@cloud-elements.com","type":"string"},"id":{"x-samplevalue":24425,"format":"int32","type":"integer"}}},"ElementInstanceConfiguration":{"type":"object","title":"configuration","properties":{"config_property_name_placeholder":{"x-samplevalue":"string","type":"string"}}},"ElementInstanceTokenPatch":{"title":"ElementInstanceTokenPatch","properties":{"elementId":{"x-samplevalue":19804,"format":"int32","type":"integer"},"lastHeartbeatCheckTime":{"x-samplevalue":1613073624005,"format":"int64","type":"integer"},"configuration":{"$ref":"#/definitions/ElementInstanceConfiguration"},"heartbeat":{"$ref":"#/definitions/ElementInstanceHeartbeat"},"eventsEnabled":{"x-samplevalue":false,"type":"boolean"},"userId":{"x-samplevalue":24425,"format":"int32","type":"integer"},"token":{"x-samplevalue":"VeBkrb9OfuQBCNOMADuz1TV1uhA0MLJAzKpkPWzYpyA=","type":"string"},"tags":{"x-samplevalue":["Zoho Crm V2"],"type":"array","items":{"type":"string"}},"valid":{"x-samplevalue":true,"type":"boolean"},"pollingForceDisabled":{"x-samplevalue":false,"type":"boolean"},"organizationId":{"x-samplevalue":976,"format":"int32","type":"integer"},"accountId":{"x-samplevalue":18937,"format":"int32","type":"integer"},"createdDate":{"x-samplevalue":"2021-01-28T07:50:32Z","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"},"name":{"x-samplevalue":"Zoho Crm V2","type":"string"},"modifiedDate":{"x-samplevalue":"2021-02-11T20:00:22Z","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"},"consecutiveRefreshFailureCount":{"x-samplevalue":0,"format":"int32","type":"integer"},"disabled":{"x-samplevalue":false,"type":"boolean"},"id":{"x-samplevalue":387377,"format":"int32","type":"integer"},"user":{"$ref":"#/definitions/ElementInstanceUser"},"externalAuthentication":{"x-samplevalue":"none","type":"string"},"element":{"$ref":"#/definitions/ElementInstanceElement"}},"type":"object"},"ElementInstanceHeartbeat":{"type":"object","title":"heartbeat","properties":{"status":{"x-samplevalue":true,"type":"boolean"}}},"ElementInstancePostElementResourcesModelSwaggerContactsGetResPropertiesEmail":{"type":"object","title":"email","properties":{"x-samplevalue":{"x-samplevalue":"support@cloud-elements.com","type":"string"},"type":{"x-samplevalue":"string","type":"string"}}},"ElementInstancePostElementResourcesModel":{"type":"object","title":"model","properties":{"transform":{"x-samplevalue":false,"type":"boolean"},"name":{"x-samplevalue":"contactsGetRes","type":"string"},"swagger":{"$ref":"#/definitions/ElementInstancePostElementResourcesModelSwagger"}}},"ElementInstancePostElementResourcesModelSwaggerContactsGetRes":{"type":"object","title":"contactsGetRes","properties":{"title":{"x-samplevalue":"contactsGetRes","type":"string"},"properties":{"$ref":"#/definitions/ElementInstancePostElementResourcesModelSwaggerContactsGetResProperties"}}},"ElementInstancePostElementResourcesModelSwaggerContactsGetResPropertiesName":{"type":"object","title":"name","properties":{"x-samplevalue":{"x-samplevalue":"example","type":"string"},"type":{"x-samplevalue":"string","type":"string"}}},"ElementInstancePostElementResourcesModelSwaggerContactsGetResProperties":{"type":"object","title":"properties","properties":{"name":{"$ref":"#/definitions/ElementInstancePostElementResourcesModelSwaggerContactsGetResPropertiesName"},"email":{"$ref":"#/definitions/ElementInstancePostElementResourcesModelSwaggerContactsGetResPropertiesEmail"}}},"ElementInstancePostElementResourcesModelSwagger":{"type":"object","title":"swagger","properties":{"contactsGetRes":{"$ref":"#/definitions/ElementInstancePostElementResourcesModelSwaggerContactsGetRes"}}},"ElementInstancePatchElementAuthentication":{"type":"object","title":"authentication","properties":{"type":{"x-samplevalue":"basic","type":"string"}}},"ElementInstancePatchElementResourcesResponse":{"type":"object","title":"response","properties":{"contentTypeAsString":{"x-samplevalue":"application/json","type":"string"},"contentType":{"x-samplevalue":"application/json","type":"string"}}},"ElementInstancePatchElementResourcesModelSwagger":{"type":"object","title":"swagger","properties":{"contactsGetRes":{"$ref":"#/definitions/ElementInstancePatchElementResourcesModelSwaggerContactsGetRes"}}},"ElementInstancePatchConfiguration":{"type":"object","title":"configuration","properties":{"config_property_name_placeholder":{"x-samplevalue":"string","type":"string"}}},"ElementInstancePatch":{"title":"ElementInstancePatch","properties":{"elementId":{"x-samplevalue":52410,"format":"int32","type":"integer"},"lastHeartbeatCheckTime":{"x-samplevalue":0,"format":"int32","type":"integer"},"configuration":{"$ref":"#/definitions/ElementInstancePatchConfiguration"},"eventsEnabled":{"x-samplevalue":false,"type":"boolean"},"traceLoggingEnabled":{"x-samplevalue":false,"type":"boolean"},"cachingEnabled":{"x-samplevalue":false,"type":"boolean"},"userId":{"x-samplevalue":24425,"format":"int32","type":"integer"},"token":{"x-samplevalue":"U38H5ZYkPi1yKsWwPYAi+1Ieg3g7TssDFsRLWJBzo8E=","type":"string"},"valid":{"x-samplevalue":true,"type":"boolean"},"pollingForceDisabled":{"x-samplevalue":false,"type":"boolean"},"organizationId":{"x-samplevalue":976,"format":"int32","type":"integer"},"accountId":{"x-samplevalue":18937,"format":"int32","type":"integer"},"createdDate":{"x-samplevalue":"2021-02-12T03:05:43Z","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"},"maxCacheSize":{"x-samplevalue":0,"format":"int32","type":"integer"},"name":{"x-samplevalue":"dummy updated","type":"string"},"modifiedDate":{"x-samplevalue":"2021-02-12T03:13:13Z","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"},"consecutiveRefreshFailureCount":{"x-samplevalue":0,"format":"int32","type":"integer"},"disabled":{"x-samplevalue":false,"type":"boolean"},"cacheTimeToLive":{"x-samplevalue":0,"format":"int32","type":"integer"},"id":{"x-samplevalue":401877,"format":"int32","type":"integer"},"authenticationType":{"x-samplevalue":"basic","type":"string"},"user":{"$ref":"#/definitions/ElementInstancePatchUser"},"externalAuthentication":{"x-samplevalue":"none","type":"string"},"element":{"$ref":"#/definitions/ElementInstancePatchElement"}},"type":"object"},"ElementInstancePatchElementResourcesModelSwaggerContactsGetResProperties":{"type":"object","title":"properties","properties":{"name":{"$ref":"#/definitions/ElementInstancePatchElementResourcesModelSwaggerContactsGetResPropertiesName"},"email":{"$ref":"#/definitions/ElementInstancePatchElementResourcesModelSwaggerContactsGetResPropertiesEmail"}}},"ElementInstancePatchElementResourcesModelSwaggerContactsGetRes":{"type":"object","title":"contactsGetRes","properties":{"title":{"x-samplevalue":"contactsGetRes","type":"string"},"properties":{"$ref":"#/definitions/ElementInstancePatchElementResourcesModelSwaggerContactsGetResProperties"}}},"ElementInstancePatchElementHooks":{"title":"hooks","properties":{"elementId":{"x-samplevalue":52410,"format":"int32","type":"integer"},"isLegacy":{"x-samplevalue":false,"type":"boolean"},"contextParams":{"type":"string"},"id":{"x-samplevalue":11498,"format":"int32","type":"integer"},"mimeType":{"x-samplevalue":"application/javascript","type":"string"},"type":{"x-samplevalue":"postRequest","type":"string"},"body":{"x-samplevalue":"done()","type":"string"}},"type":"object"},"ElementInstancePatchElementResourcesModel":{"type":"object","title":"model","properties":{"transform":{"x-samplevalue":false,"type":"boolean"},"name":{"x-samplevalue":"contactsGetRes","type":"string"},"swagger":{"$ref":"#/definitions/ElementInstancePatchElementResourcesModelSwagger"}}},"ElementInstancePatchElementResourcesHooks":{"title":"hooks","properties":{"resourceId":{"x-samplevalue":571873,"format":"int32","type":"integer"},"isLegacy":{"x-samplevalue":false,"type":"boolean"},"contextParams":{"type":"string"},"id":{"x-samplevalue":102257,"format":"int32","type":"integer"},"mimeType":{"x-samplevalue":"application/javascript","type":"string"},"type":{"x-samplevalue":"preRequest","type":"string"},"body":{"x-samplevalue":"done()","type":"string"}},"type":"object"},"ElementInstancePatchElementParameters":{"title":"parameters","properties":{"vendorType":{"x-samplevalue":"header","type":"string"},"elementId":{"x-samplevalue":52410,"format":"int32","type":"integer"},"createdDate":{"x-samplevalue":"2021-02-12T03:04:18Z","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"},"name":{"x-samplevalue":"application/json","type":"string"},"id":{"x-samplevalue":46121,"format":"int32","type":"integer"},"updatedDate":{"x-samplevalue":"2021-02-12T03:04:25Z","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"},"source":{"x-samplevalue":"request","type":"string"},"vendorName":{"x-samplevalue":"Accept","type":"string"},"type":{"x-samplevalue":"value","type":"string"},"required":{"x-samplevalue":false,"type":"boolean"}},"type":"object"},"ElementInstancePatchElement":{"type":"object","title":"element","properties":{"version":{"x-samplevalue":"1.0.0","type":"string"},"private":{"x-samplevalue":true,"type":"boolean"},"configuration":{"type":"array","items":{"$ref":"#/definitions/ElementInstancePatchElementConfiguration"}},"objects":{"type":"array","items":{"$ref":"#/definitions/ElementInstancePatchElementObjects"}},"description":{"x-samplevalue":"A dummy element that responds with fixed responses","type":"string"},"cloneable":{"x-samplevalue":false,"type":"boolean"},"extended":{"x-samplevalue":false,"type":"boolean"},"bulkDownloadEnabled":{"x-samplevalue":false,"type":"boolean"},"useModelsForMetadata":{"x-samplevalue":true,"type":"boolean"},"paginatorVersion":{"x-samplevalue":"V2","type":"string"},"trialAccount":{"x-samplevalue":false,"type":"boolean"},"logo":{"x-samplevalue":"dummy","type":"string"},"id":{"x-samplevalue":52410,"format":"int32","type":"integer"},"hooks":{"type":"array","items":{"$ref":"#/definitions/ElementInstancePatchElementHooks"}},"key":{"x-samplevalue":"dummy","type":"string"},"beta":{"x-samplevalue":false,"type":"boolean"},"authentication":{"$ref":"#/definitions/ElementInstancePatchElementAuthentication"},"bulkUploadEnabled":{"x-samplevalue":false,"type":"boolean"},"image":{"x-samplevalue":"elements/custom-element-default-logo.png","type":"string"},"active":{"x-samplevalue":true,"type":"boolean"},"resources":{"type":"array","items":{"$ref":"#/definitions/ElementInstancePatchElementResources"}},"modelType":{"x-samplevalue":"basic","type":"string"},"protocolType":{"x-samplevalue":"http","type":"string"},"transformationsEnabled":{"x-samplevalue":true,"type":"boolean"},"childTransformationsEnabled":{"x-samplevalue":true,"type":"boolean"},"deleted":{"x-samplevalue":false,"type":"boolean"},"hub":{"x-samplevalue":"general","type":"string"},"typeOauth":{"x-samplevalue":false,"type":"boolean"},"name":{"x-samplevalue":"dummy","type":"string"},"extendable":{"x-samplevalue":true,"type":"boolean"},"parameters":{"type":"array","items":{"$ref":"#/definitions/ElementInstancePatchElementParameters"}}}},"ElementInstancePatchUser":{"type":"object","title":"user","properties":{"firstName":{"x-samplevalue":"Rahul","type":"string"},"lastName":{"x-samplevalue":"Gupta","type":"string"},"emailAddress":{"x-samplevalue":"rahul@cloud-elements.com","type":"string"},"id":{"x-samplevalue":24425,"format":"int32","type":"integer"}}},"ElementInstancePatchElementResourcesModelSwaggerContactsGetResPropertiesEmail":{"type":"object","title":"email","properties":{"x-samplevalue":{"x-samplevalue":"support@cloud-elements.com","type":"string"},"type":{"x-samplevalue":"string","type":"string"}}},"ElementInstancePatchElementResourcesParameters":{"title":"parameters","properties":{"vendorType":{"x-samplevalue":"query","type":"string"},"resourceId":{"x-samplevalue":571873,"format":"int32","type":"integer"},"dataType":{"x-samplevalue":"string","type":"string"},"converter":{"x-samplevalue":"toQueryParameters","type":"string"},"description":{"x-samplevalue":"The page number of resources to retrieve","type":"string"},"vendorDataType":{"x-samplevalue":"string","type":"string"},"updatedDate":{"x-samplevalue":"2021-02-12T03:04:25Z","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"},"source":{"x-samplevalue":"request","type":"string"},"vendorName":{"x-samplevalue":"page","type":"string"},"type":{"x-samplevalue":"query","type":"string"},"required":{"x-samplevalue":false,"type":"boolean"},"createdDate":{"x-samplevalue":"2021-02-12T03:04:18Z","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"},"name":{"x-samplevalue":"page","type":"string"},"id":{"x-samplevalue":1336324,"format":"int32","type":"integer"}},"type":"object"},"ElementInstancePatchElementConfiguration":{"title":"configuration","properties":{"internal":{"x-samplevalue":false,"type":"boolean"},"companyConfig":{"x-samplevalue":false,"type":"boolean"},"defaultValue":{"x-samplevalue":"100","type":"string"},"displayOrder":{"x-samplevalue":1,"format":"int32","type":"integer"},"description":{"x-samplevalue":"dummy Base Url","type":"string"},"active":{"x-samplevalue":true,"type":"boolean"},"isPrivate":{"x-samplevalue":false,"type":"boolean"},"type":{"x-samplevalue":"TEXTFIELD_1000","type":"string"},"resellerConfig":{"x-samplevalue":false,"type":"boolean"},"required":{"x-samplevalue":true,"type":"boolean"},"hideFromConsole":{"x-samplevalue":true,"type":"boolean"},"name":{"x-samplevalue":"Base Url","type":"string"},"id":{"x-samplevalue":560911,"format":"int32","type":"integer"},"groupControl":{"x-samplevalue":false,"type":"boolean"},"key":{"x-samplevalue":"base.url","type":"string"}},"type":"object"},"ElementInstancePatchElementResourcesModelSwaggerContactsGetResPropertiesName":{"type":"object","title":"name","properties":{"x-samplevalue":{"x-samplevalue":"example","type":"string"},"type":{"x-samplevalue":"string","type":"string"}}},"ElementInstancePatchElementObjects":{"title":"objects","properties":{"elementId":{"x-samplevalue":52410,"format":"int32","type":"integer"},"bulkUploadEnabled":{"x-samplevalue":true,"type":"boolean"},"metadataDiscovery":{"x-samplevalue":false,"type":"boolean"},"updatedDateName":{"type":"string"},"createdDateName":{"type":"string"},"eventsEnabled":{"x-samplevalue":false,"type":"boolean"},"eventCreatedSupported":{"x-samplevalue":false,"type":"boolean"},"nativeBulkUpload":{"x-samplevalue":false,"type":"boolean"},"tags":{"x-samplevalue":["tag1"],"type":"array","items":{"type":"string"}},"createdDateFormat":{"type":"string"},"updatedDateFormat":{"type":"string"},"bulkDownloadEnabled":{"x-samplevalue":true,"type":"boolean"},"ownerAccountId":{"x-samplevalue":18937,"format":"int32","type":"integer"},"name":{"x-samplevalue":"contacts","type":"string"},"operationsSupported":{"x-samplevalue":["unknown"],"type":"array","items":{"type":"string"}},"hulkDownloadEnabled":{"x-samplevalue":false,"type":"boolean"},"eventUpdatedSupported":{"x-samplevalue":false,"type":"boolean"},"id":{"x-samplevalue":89140,"format":"int32","type":"integer"},"primaryKeyName":{"x-samplevalue":"id","type":"string"},"nativeBulkDownload":{"x-samplevalue":false,"type":"boolean"},"migrated":{"x-samplevalue":false,"type":"boolean"},"hulkUploadEnabled":{"x-samplevalue":false,"type":"boolean"},"eventDeletedSupported":{"x-samplevalue":false,"type":"boolean"}},"type":"object"},"ElementInstancePatchElementResources":{"title":"resources","properties":{"method":{"x-samplevalue":"GET","type":"string"},"kind":{"x-samplevalue":"eb","type":"string"},"description":{"x-samplevalue":"Search for contacts","type":"string"},"updatedDate":{"x-samplevalue":"2021-02-12T03:04:25Z","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"},"type":{"x-samplevalue":"api","type":"string"},"vendorPath":{"x-samplevalue":"/contacts","type":"string"},"path":{"x-samplevalue":"/hubs/general/contacts","type":"string"},"createdDate":{"x-samplevalue":"2021-02-12T03:04:18Z","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"},"vendorMethod":{"x-samplevalue":"GET","type":"string"},"response":{"$ref":"#/definitions/ElementInstancePatchElementResourcesResponse"},"ownerAccountId":{"x-samplevalue":18937,"format":"int32","type":"integer"},"objectName":{"x-samplevalue":"contacts","type":"string"},"tryitoutDisable":{"x-samplevalue":false,"type":"boolean"},"model":{"$ref":"#/definitions/ElementInstancePatchElementResourcesModel"},"id":{"x-samplevalue":571873,"format":"int32","type":"integer"},"parameters":{"type":"array","items":{"$ref":"#/definitions/ElementInstancePatchElementResourcesParameters"}},"hooks":{"type":"array","items":{"$ref":"#/definitions/ElementInstancePatchElementResourcesHooks"}}},"type":"object"},"ElementInstanceGetByIdElement":{"type":"object","title":"element","properties":{"version":{"x-samplevalue":"1.0.0","type":"string"},"private":{"x-samplevalue":true,"type":"boolean"},"objects":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceGetByIdElementObjects"}},"description":{"x-samplevalue":"A dummy element that responds with fixed responses","type":"string"},"cloneable":{"x-samplevalue":false,"type":"boolean"},"extended":{"x-samplevalue":false,"type":"boolean"},"bulkDownloadEnabled":{"x-samplevalue":false,"type":"boolean"},"useModelsForMetadata":{"x-samplevalue":true,"type":"boolean"},"paginatorVersion":{"x-samplevalue":"V2","type":"string"},"trialAccount":{"x-samplevalue":false,"type":"boolean"},"logo":{"x-samplevalue":"dummy","type":"string"},"id":{"x-samplevalue":52410,"format":"int32","type":"integer"},"key":{"x-samplevalue":"dummy","type":"string"},"beta":{"x-samplevalue":false,"type":"boolean"},"authentication":{"$ref":"#/definitions/ElementInstanceGetByIdElementAuthentication"},"bulkUploadEnabled":{"x-samplevalue":false,"type":"boolean"},"image":{"x-samplevalue":"elements/custom-element-default-logo.png","type":"string"},"active":{"x-samplevalue":true,"type":"boolean"},"resources":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceGetByIdElementResources"}},"modelType":{"x-samplevalue":"basic","type":"string"},"protocolType":{"x-samplevalue":"http","type":"string"},"transformationsEnabled":{"x-samplevalue":true,"type":"boolean"},"childTransformationsEnabled":{"x-samplevalue":true,"type":"boolean"},"deleted":{"x-samplevalue":false,"type":"boolean"},"hub":{"x-samplevalue":"general","type":"string"},"typeOauth":{"x-samplevalue":false,"type":"boolean"},"name":{"x-samplevalue":"dummy","type":"string"},"extendable":{"x-samplevalue":true,"type":"boolean"},"parameters":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceGetByIdElementParameters"}}}},"ElementInstanceGetByIdUser":{"type":"object","title":"user","properties":{"firstName":{"x-samplevalue":"Rahul","type":"string"},"lastName":{"x-samplevalue":"Gupta","type":"string"},"emailAddress":{"x-samplevalue":"rahul@cloud-elements.com","type":"string"},"id":{"x-samplevalue":24425,"format":"int32","type":"integer"}}},"ElementInstanceGetByIdElementAuthentication":{"type":"object","title":"authentication","properties":{"type":{"x-samplevalue":"custom","type":"string"}}},"ElementInstanceGetByIdElementResourcesModelSwaggerContactsGetRes":{"type":"object","title":"contactsGetRes","properties":{"title":{"x-samplevalue":"contactsGetRes","type":"string"},"properties":{"$ref":"#/definitions/ElementInstanceGetByIdElementResourcesModelSwaggerContactsGetResProperties"}}},"ElementInstanceGetByIdConfiguration":{"type":"object","title":"configuration","properties":{"config_property_name_placeholder":{"x-samplevalue":"string","type":"string"}}},"ElementInstanceGetByIdElementResourcesParameters":{"title":"parameters","properties":{"vendorType":{"x-samplevalue":"query","type":"string"},"resourceId":{"x-samplevalue":571873,"format":"int32","type":"integer"},"dataType":{"x-samplevalue":"string","type":"string"},"converter":{"x-samplevalue":"toQueryParameters","type":"string"},"description":{"x-samplevalue":"The page number of resources to retrieve","type":"string"},"vendorDataType":{"x-samplevalue":"string","type":"string"},"updatedDate":{"x-samplevalue":"2021-02-12T03:04:25Z","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"},"source":{"x-samplevalue":"request","type":"string"},"vendorName":{"x-samplevalue":"page","type":"string"},"type":{"x-samplevalue":"query","type":"string"},"required":{"x-samplevalue":false,"type":"boolean"},"createdDate":{"x-samplevalue":"2021-02-12T03:04:18Z","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"},"name":{"x-samplevalue":"page","type":"string"},"id":{"x-samplevalue":1336324,"format":"int32","type":"integer"}},"type":"object"},"ElementInstanceGetByIdElementResourcesResponse":{"type":"object","title":"response","properties":{"contentTypeAsString":{"x-samplevalue":"application/json","type":"string"},"contentType":{"x-samplevalue":"application/json","type":"string"}}},"ElementInstanceGetByIdElementResourcesModel":{"type":"object","title":"model","properties":{"transform":{"x-samplevalue":false,"type":"boolean"},"name":{"x-samplevalue":"contactsGetRes","type":"string"},"swagger":{"$ref":"#/definitions/ElementInstanceGetByIdElementResourcesModelSwagger"}}},"ElementInstanceGetByIdElementResources":{"title":"resources","properties":{"method":{"x-samplevalue":"GET","type":"string"},"kind":{"x-samplevalue":"eb","type":"string"},"description":{"x-samplevalue":"Search for contacts","type":"string"},"updatedDate":{"x-samplevalue":"2021-02-12T03:04:25Z","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"},"type":{"x-samplevalue":"api","type":"string"},"vendorPath":{"x-samplevalue":"/contacts","type":"string"},"path":{"x-samplevalue":"/hubs/general/contacts","type":"string"},"createdDate":{"x-samplevalue":"2021-02-12T03:04:18Z","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"},"vendorMethod":{"x-samplevalue":"GET","type":"string"},"response":{"$ref":"#/definitions/ElementInstanceGetByIdElementResourcesResponse"},"ownerAccountId":{"x-samplevalue":18937,"format":"int32","type":"integer"},"objectName":{"x-samplevalue":"contacts","type":"string"},"tryitoutDisable":{"x-samplevalue":false,"type":"boolean"},"model":{"$ref":"#/definitions/ElementInstanceGetByIdElementResourcesModel"},"id":{"x-samplevalue":571873,"format":"int32","type":"integer"},"parameters":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceGetByIdElementResourcesParameters"}},"hooks":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceGetByIdElementResourcesHooks"}}},"type":"object"},"ElementInstanceGetByIdElementResourcesModelSwaggerContactsGetResProperties":{"type":"object","title":"properties","properties":{"name":{"$ref":"#/definitions/ElementInstanceGetByIdElementResourcesModelSwaggerContactsGetResPropertiesName"},"email":{"$ref":"#/definitions/ElementInstanceGetByIdElementResourcesModelSwaggerContactsGetResPropertiesEmail"}}},"ElementInstanceGetByIdElementResourcesHooks":{"title":"hooks","properties":{"resourceId":{"x-samplevalue":571873,"format":"int32","type":"integer"},"isLegacy":{"x-samplevalue":false,"type":"boolean"},"contextParams":{"type":"string"},"id":{"x-samplevalue":102257,"format":"int32","type":"integer"},"mimeType":{"x-samplevalue":"application/javascript","type":"string"},"type":{"x-samplevalue":"preRequest","type":"string"},"body":{"x-samplevalue":"done()","type":"string"}},"type":"object"},"ElementInstanceGetByIdElementObjects":{"title":"objects","properties":{"elementId":{"x-samplevalue":52410,"format":"int32","type":"integer"},"bulkUploadEnabled":{"x-samplevalue":true,"type":"boolean"},"metadataDiscovery":{"x-samplevalue":false,"type":"boolean"},"updatedDateName":{"type":"string"},"createdDateName":{"type":"string"},"eventsEnabled":{"x-samplevalue":false,"type":"boolean"},"eventCreatedSupported":{"x-samplevalue":false,"type":"boolean"},"nativeBulkUpload":{"x-samplevalue":false,"type":"boolean"},"tags":{"type":"array","items":{"type":"string"}},"createdDateFormat":{"type":"string"},"updatedDateFormat":{"type":"string"},"bulkDownloadEnabled":{"x-samplevalue":true,"type":"boolean"},"ownerAccountId":{"x-samplevalue":18937,"format":"int32","type":"integer"},"name":{"x-samplevalue":"contacts","type":"string"},"operationsSupported":{"x-samplevalue":["unknown"],"type":"array","items":{"type":"string"}},"hulkDownloadEnabled":{"x-samplevalue":false,"type":"boolean"},"eventUpdatedSupported":{"x-samplevalue":false,"type":"boolean"},"id":{"x-samplevalue":89140,"format":"int32","type":"integer"},"primaryKeyName":{"x-samplevalue":"id","type":"string"},"nativeBulkDownload":{"x-samplevalue":false,"type":"boolean"},"migrated":{"x-samplevalue":false,"type":"boolean"},"hulkUploadEnabled":{"x-samplevalue":false,"type":"boolean"},"eventDeletedSupported":{"x-samplevalue":false,"type":"boolean"}},"type":"object"},"ElementInstanceGetByIdElementResourcesModelSwaggerContactsGetResPropertiesName":{"type":"object","title":"name","properties":{"x-samplevalue":{"x-samplevalue":"example","type":"string"},"type":{"x-samplevalue":"string","type":"string"}}},"ElementInstanceGetById":{"title":"ElementInstanceGetById","properties":{"configuration":{"$ref":"#/definitions/ElementInstanceGetByIdConfiguration"},"traceLoggingEnabled":{"x-samplevalue":false,"type":"boolean"},"valid":{"x-samplevalue":true,"type":"boolean"},"pollingForceDisabled":{"x-samplevalue":false,"type":"boolean"},"organizationId":{"x-samplevalue":976,"format":"int32","type":"integer"},"consecutiveRefreshFailureCount":{"x-samplevalue":0,"format":"int32","type":"integer"},"disabled":{"x-samplevalue":false,"type":"boolean"},"id":{"x-samplevalue":401877,"format":"int32","type":"integer"},"externalAuthentication":{"x-samplevalue":"none","type":"string"},"element":{"$ref":"#/definitions/ElementInstanceGetByIdElement"},"elementId":{"x-samplevalue":52410,"format":"int32","type":"integer"},"lastHeartbeatCheckTime":{"x-samplevalue":0,"format":"int32","type":"integer"},"eventsEnabled":{"x-samplevalue":false,"type":"boolean"},"cachingEnabled":{"x-samplevalue":false,"type":"boolean"},"userId":{"x-samplevalue":24425,"format":"int32","type":"integer"},"token":{"x-samplevalue":"U38H5ZYkPi1yKsWwPYAi+1Ieg3g7TssDFsRLWJBzo8E=","type":"string"},"tags":{"x-samplevalue":["dummy"],"type":"array","items":{"type":"string"}},"accountId":{"x-samplevalue":18937,"format":"int32","type":"integer"},"createdDate":{"x-samplevalue":"2021-02-12T03:05:43Z","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"},"maxCacheSize":{"x-samplevalue":0,"format":"int32","type":"integer"},"name":{"x-samplevalue":"dummy updated","type":"string"},"modifiedDate":{"x-samplevalue":"2021-02-12T03:13:13Z","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"},"cacheTimeToLive":{"x-samplevalue":0,"format":"int32","type":"integer"},"authenticationType":{"x-samplevalue":"custom","type":"string"},"user":{"$ref":"#/definitions/ElementInstanceGetByIdUser"}},"type":"object"},"ElementInstanceGetByIdElementResourcesModelSwagger":{"type":"object","title":"swagger","properties":{"contactsGetRes":{"$ref":"#/definitions/ElementInstanceGetByIdElementResourcesModelSwaggerContactsGetRes"}}},"ElementInstanceGetByIdElementParameters":{"title":"parameters","properties":{"vendorType":{"x-samplevalue":"header","type":"string"},"elementId":{"x-samplevalue":52410,"format":"int32","type":"integer"},"createdDate":{"x-samplevalue":"2021-02-12T03:04:18Z","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"},"name":{"x-samplevalue":"application/json","type":"string"},"id":{"x-samplevalue":46121,"format":"int32","type":"integer"},"updatedDate":{"x-samplevalue":"2021-02-12T03:04:25Z","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"},"source":{"x-samplevalue":"request","type":"string"},"vendorName":{"x-samplevalue":"Accept","type":"string"},"type":{"x-samplevalue":"value","type":"string"},"required":{"x-samplevalue":false,"type":"boolean"}},"type":"object"},"ElementInstanceGetByIdElementResourcesModelSwaggerContactsGetResPropertiesEmail":{"type":"object","title":"email","properties":{"x-samplevalue":{"x-samplevalue":"support@cloud-elements.com","type":"string"},"type":{"x-samplevalue":"string","type":"string"}}},"ElementInstanceConfigurationGetResObject":{"title":"ElementInstanceConfigurationGetRes","type":"object","properties":{"internal":{"x-samplevalue":false,"type":"boolean"},"companyConfig":{"x-samplevalue":false,"type":"boolean"},"defaultValue":{"x-samplevalue":"100","type":"string"},"dirtyFlag":{"x-samplevalue":false,"type":"boolean"},"displayOrder":{"x-samplevalue":1,"format":"int32","type":"integer"},"description":{"x-samplevalue":"dummy Base Url","type":"string"},"active":{"x-samplevalue":true,"type":"boolean"},"readOnly":{"x-samplevalue":true,"type":"boolean"},"propertyValue":{"x-samplevalue":"100","type":"string"},"isPrivate":{"x-samplevalue":false,"type":"boolean"},"type":{"x-samplevalue":"TEXTFIELD_1000","type":"string"},"resellerConfig":{"x-samplevalue":false,"type":"boolean"},"required":{"x-samplevalue":true,"type":"boolean"},"hideFromConsole":{"x-samplevalue":true,"type":"boolean"},"name":{"x-samplevalue":"Base Url","type":"string"},"id":{"x-samplevalue":560911,"format":"int32","type":"integer"},"groupControl":{"x-samplevalue":false,"type":"boolean"},"key":{"x-samplevalue":"base.url","type":"string"}},"required":["id","key"]},"ElementInstanceConfigurationGetRes":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceConfigurationGetResObject"}},"ElementInstanceTokenConfigurationGetResObject":{"title":"ElementInstanceTokenConfigurationGetRes","type":"object","properties":{"internal":{"x-samplevalue":false,"type":"boolean"},"companyConfig":{"x-samplevalue":false,"type":"boolean"},"defaultValue":{"x-samplevalue":"100","type":"string"},"dirtyFlag":{"x-samplevalue":false,"type":"boolean"},"displayOrder":{"x-samplevalue":1,"format":"int32","type":"integer"},"description":{"x-samplevalue":"dummy Base Url","type":"string"},"active":{"x-samplevalue":true,"type":"boolean"},"readOnly":{"x-samplevalue":true,"type":"boolean"},"propertyValue":{"x-samplevalue":"100","type":"string"},"isPrivate":{"x-samplevalue":false,"type":"boolean"},"type":{"x-samplevalue":"TEXTFIELD_1000","type":"string"},"resellerConfig":{"x-samplevalue":false,"type":"boolean"},"required":{"x-samplevalue":true,"type":"boolean"},"hideFromConsole":{"x-samplevalue":true,"type":"boolean"},"name":{"x-samplevalue":"Base Url","type":"string"},"id":{"x-samplevalue":560911,"format":"int32","type":"integer"},"groupControl":{"x-samplevalue":false,"type":"boolean"},"key":{"x-samplevalue":"base.url","type":"string"}}},"ElementInstanceTokenConfigurationGetRes":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceTokenConfigurationGetResObject"}},"ElementInstanceTokenConfigurationPatchRes":{"title":"ElementInstanceTokenConfigurationPatchRes","properties":{"internal":{"x-samplevalue":false,"type":"boolean"},"companyConfig":{"x-samplevalue":false,"type":"boolean"},"dirtyFlag":{"x-samplevalue":true,"type":"boolean"},"displayOrder":{"x-samplevalue":1,"format":"int32","type":"integer"},"description":{"x-samplevalue":"dummy Base Url","type":"string"},"active":{"x-samplevalue":true,"type":"boolean"},"propertyValue":{"x-samplevalue":"base.url","type":"string"},"readOnly":{"x-samplevalue":true,"type":"boolean"},"isPrivate":{"x-samplevalue":false,"type":"boolean"},"type":{"x-samplevalue":"TEXTFIELD_1000","type":"string"},"resellerConfig":{"x-samplevalue":false,"type":"boolean"},"required":{"x-samplevalue":true,"type":"boolean"},"hideFromConsole":{"x-samplevalue":true,"type":"boolean"},"name":{"x-samplevalue":"Base Url","type":"string"},"id":{"x-samplevalue":560911,"format":"int32","type":"integer"},"groupControl":{"x-samplevalue":false,"type":"boolean"},"key":{"x-samplevalue":"base.url","type":"string"}},"type":"object"},"SwaggerOperationDefinitionsDefinitions":{"type":"object","title":"definitions","properties":{"operationModel":{"$ref":"#/definitions/SwaggerOperationDefinitionsDefinitionsOperationModel"}}},"SwaggerOperationDefinitionsDefinitionsOperationModel":{"type":"object","title":"operationModel","properties":{"title":{"x-samplevalue":"operationModel","type":"string"},"properties":{"$ref":"#/definitions/SwaggerOperationDefinitionsDefinitionsOperationModelProperties"}}},"SwaggerOperationDefinitions":{"title":"SwaggerOperationDefinitions","properties":{"responseModel":{"x-samplevalue":"operationModel","type":"string"},"definitions":{"$ref":"#/definitions/SwaggerOperationDefinitionsDefinitions"}},"type":"object"},"SwaggerOperationDefinitionsDefinitionsOperationModelPropertiesProperty_key":{"type":"object","title":"property_key","properties":{"x-samplevalue":{"x-samplevalue":"property_value","type":"string"},"type":{"x-samplevalue":"string","type":"string"}}},"SwaggerOperationDefinitionsDefinitionsOperationModelProperties":{"type":"object","title":"properties","properties":{"property_key":{"$ref":"#/definitions/SwaggerOperationDefinitionsDefinitionsOperationModelPropertiesProperty_key"},"type":{"x-samplevalue":"object","type":"string"}}},"ElementInstanceTransformationsListVdrNameFields":{"title":"fields","properties":{"path":{"x-samplevalue":"id","type":"string"},"level":{"x-samplevalue":"organization","type":"string"},"id":{"x-samplevalue":680821,"format":"int32","type":"integer"},"type":{"x-samplevalue":"string","type":"string"},"vendorPath":{"x-samplevalue":"id","type":"string"},"vdrFieldId":{"x-samplevalue":915047,"format":"int32","type":"integer"}},"type":"object"},"ElementInstanceTransformationsList":{"title":"ElementInstanceTransformationsList","properties":{"vdrName":{"$ref":"#/definitions/ElementInstanceTransformationsListVdrName"}},"type":"object"},"ElementInstanceTransformationsListVdrName":{"type":"object","title":"vdrName","properties":{"elementKey":{"x-samplevalue":"dummy","type":"string"},"elementId":{"x-samplevalue":52410,"format":"int32","type":"integer"},"isLegacy":{"x-samplevalue":false,"type":"boolean"},"configuration":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceTransformationsListVdrNameConfiguration"}},"objectName":{"x-samplevalue":"vdrName","type":"string"},"id":{"x-samplevalue":101151,"format":"int32","type":"integer"},"vendorName":{"x-samplevalue":"contacts","type":"string"},"fields":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceTransformationsListVdrNameFields"}}}},"ElementInstanceTransformationsListVdrNameConfiguration":{"title":"configuration","properties":{"associatedId":{"x-samplevalue":401877,"format":"int32","type":"integer"},"level":{"x-samplevalue":"instance","type":"string"},"type":{"x-samplevalue":"addToDocumentation","type":"string"},"properties":{"$ref":"#/definitions/ElementInstanceTransformationsListVdrNameConfigurationProperties"}},"type":"object"},"ElementInstanceTransformationsListVdrNameConfigurationProperties":{"type":"object","title":"properties","properties":{"fromVendor":{"x-samplevalue":false,"type":"boolean"},"toVendor":{"x-samplevalue":false,"type":"boolean"}}},"ElementInstanceObjectDefinitionsList":{"title":"ElementInstanceObjectDefinitionsList","properties":{"vdrName":{"$ref":"#/definitions/ElementInstanceObjectDefinitionsListVdrName"}},"type":"object"},"ElementInstanceObjectDefinitionsListVdrName":{"type":"object","title":"vdrName","properties":{"owner":{"x-samplevalue":"Rahul Gupta","type":"string"},"mappedElementIds":{"x-samplevalue":[7186,34562],"type":"array","items":{"type":"integer"}},"level":{"x-samplevalue":"organization","type":"string"},"vdrShareLevel":{"x-samplevalue":"organization","type":"string"},"description":{"x-samplevalue":"An individual or business that provides goods or services","type":"string"},"userId":{"x-samplevalue":24425,"format":"int32","type":"integer"},"accountId":{"x-samplevalue":18937,"format":"int32","type":"integer"},"companyId":{"x-samplevalue":976,"format":"int32","type":"integer"},"createdDate":{"x-samplevalue":"2020-11-11 16:02:13.913925","x-mask":"yyyy-MM-dd HH:mm:ss","format":"date-time","type":"string"},"organization":{"x-samplevalue":"Rahul Gupta's Company","type":"string"},"objectName":{"x-samplevalue":"ce-vendors","type":"string"},"vdrShared":{"x-samplevalue":true,"type":"boolean"},"id":{"x-samplevalue":53325,"format":"int32","type":"integer"},"fields":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceObjectDefinitionsListVdrNameFields"}}}},"ElementInstanceObjectDefinitionsListVdrNameFields":{"title":"fields","properties":{"path":{"x-samplevalue":"parent.name","type":"string"},"level":{"x-samplevalue":"organization","type":"string"},"displayName":{"type":"string"},"id":{"x-samplevalue":607636,"format":"int32","type":"integer"},"type":{"x-samplevalue":"string","type":"string"}},"type":"object"},"ElementInstanceEventsEventElementInstances":{"title":"eventElementInstances","properties":{"eventId":{"x-samplevalue":"AXeFSaqcK1yrLry4V-TW","type":"string"},"accountId":{"x-samplevalue":18937,"format":"int32","type":"integer"},"createdDate":{"x-samplevalue":"2021-02-09T05:35:34Z","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"},"elementInstanceId":{"x-samplevalue":398886,"format":"int32","type":"integer"},"notificationId":{"x-samplevalue":16724462,"format":"int32","type":"integer"},"notifiedData":{"x-samplevalue":"{\"accountId\":18937,\"companyId\":976,\"elementKey\":\"xerov2\",\"eventId\":\"AXeF1bCZZqAtOdzVFXXT\",\"events\":[{\"objectId\":\"null\",\"date\":\"2021-02-09T08:08:30Z\",\"pollDate\":\"2021-02-09T08:08:28Z\",\"elementKey\":\"xerov2\",\"hubKey\":\"finance\"}],\"instanceId\":398886,\"instanceName\":\"Xero V2\",\"instanceTags\":[\"Xero V2\"],\"instance_id\":398886,\"raw\":{\"contacts\":[{\"Addresses\":[{\"AddressType\":\"STREET\",\"City\":\"\",\"Country\":\"\",\"PostalCode\":\"\",\"Region\":\"\"},{\"AddressType\":\"POBOX\",\"City\":\"\",\"Country\":\"\",\"PostalCode\":\"\",\"Region\":\"\"}],\"BankAccountDetails\":\"\",\"ContactID\":\"d23ac4de-b4ab-4a11-b472-53c022f2235e\",\"ContactNumber\":\"15\",\"ContactStatus\":\"ACTIVE\",\"EmailAddress\":\"\",\"HasAttachments\":false,\"HasValidationErrors\":false,\"IsCustomer\":false,\"IsSupplier\":false,\"Name\":\"test events4\",\"Phones\":[{\"PhoneAreaCode\":\"\",\"PhoneCountryCode\":\"\",\"PhoneNumber\":\"\",\"PhoneType\":\"DDI\"},{\"PhoneAreaCode\":\"\",\"PhoneCountryCode\":\"\",\"PhoneNumber\":\"\",\"PhoneType\":\"DEFAULT\"},{\"PhoneAreaCode\":\"\",\"PhoneCountryCode\":\"\",\"PhoneNumber\":\"\",\"PhoneType\":\"FAX\"},{\"PhoneAreaCode\":\"\",\"PhoneCountryCode\":\"\",\"PhoneNumber\":\"\",\"PhoneType\":\"MOBILE\"}],\"UpdatedDateUTC\":\"2021-02-09T08:08:09.797Z\",\"eventType\":\"UPDATED\",\"objectId\":\"d23ac4de-b4ab-4a11-b472-53c022f2235e\"}],\"objectType\":\"contacts\",\"pollDate\":1612858108444},\"userId\":24425}","type":"string"},"updatedDate":{"x-samplevalue":"2021-02-09T05:35:34Z","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"},"error":{"x-samplevalue":"code: 400, headers: {X-Envoy-Upstream-Service-Time=317, Strict-Transport-Security=max-age=31536000;includeSubDomains, Elements-Request-Id=60221f25e4b0e06ee813fe7c, Server=istio-envoy, Www-Authenticate=Key realm=\"kong\", Connection=keep-alive, Vary=Accept-Encoding, Date=Tue, 09 Feb 2021 05:35:33 GMT, Content-Type=application/json}, body: {requestId=60221f25e4b0e06ee813fe7c, message=No provider events found for event AXeFSaqcK1yrLry4V-TW and 'xerov2' instance 398886}, cause: null","type":"string"},"userId":{"x-samplevalue":24425,"format":"int32","type":"integer"},"objectIds":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceEventsEventElementInstancesObjectIds"}}},"type":"object"},"ElementInstanceEventsEventElementInstancesObjectIds":{"title":"objectIds","properties":{"value":{"x-samplevalue":"734b6425-ea65-4a1c-8795-51a146265894","type":"string"}},"type":"object"},"ElementInstanceEventsObject":{"title":"ElementInstanceEvents","type":"object","properties":{"elementKey":{"x-samplevalue":"xerov2","type":"string"},"eventElementInstances":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceEventsEventElementInstances"}},"providerData":{"x-samplevalue":"{\"contacts\":[{\"accountId\":18937}],\"instance_id\":398886,\"objectType\":\"contacts\",\"pollDate\":1612861709058}","type":"string"},"id":{"x-samplevalue":"AXeGDKPLx4hMYmlifJLe","type":"string"},"eventDate":{"x-samplevalue":"2021-02-09T09:08:31Z","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"},"status":{"x-samplevalue":"NOTIFIED","type":"string"}}},"ElementInstanceEvents":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceEventsObject"}},"ElementInstanceEventsDispositions":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceEventsDispositionsObject"}},"ElementInstanceEventsDispositionsObject":{"title":"ElementInstanceEventsDispositions","type":"object","properties":{"eventId":{"x-samplevalue":"AXeGDKPLx4hMYmlifJLe","type":"string"},"notificationData":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceEventsDispositionsNotificationData"}},"elementInstanceId":{"x-samplevalue":398886,"format":"int32","type":"integer"},"eventStatus":{"x-samplevalue":"NOTIFIED","type":"string"},"dispositionDate":{"x-samplevalue":"2021-02-09T09:08:31Z","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"}}},"ElementInstanceEventsDispositionsNotificationData":{"title":"notificationData","properties":{"message":{"x-samplevalue":"Delivered event to https://rahul.free.beeceptor.com","type":"string"},"statusCode":{"x-samplevalue":200,"format":"int32","type":"integer"},"notificationDate":{"x-samplevalue":"2021-02-09T09:08:31Z","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"}},"type":"object"},"AnalyticsEntry":{"properties":{"count":{"type":"integer"},"timestamp":{"format":"date-time","type":"string"}},"type":"object"},"AccountAnalyticsRecord":{"properties":{"accountId":{"type":"integer"},"success":{"type":"integer"},"failed":{"type":"integer"},"count":{"type":"integer"}},"type":"object"},"AccountAnalyticsEntry":{"properties":{"records":{"type":"array","items":{"$ref":"#/definitions/AccountAnalyticsRecord"}},"total":{"type":"integer"},"timestamp":{"format":"date-time","type":"string"}},"type":"object"},"InstanceAnalyticsRecord":{"properties":{"instanceId":{"type":"integer"},"count":{"type":"integer"}},"type":"object"},"InstanceAnalyticsEntry":{"properties":{"records":{"type":"array","items":{"$ref":"#/definitions/InstanceAnalyticsRecord"}},"total":{"type":"integer"},"timestamp":{"format":"date-time","type":"string"}},"type":"object"},"InstancesPollingDisabledPollingErrorDetails":{"properties":{"lastPollISO8601":{"x-samplevalue":"2020-10-11T22:27:16+05:30","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"},"lastPoll":{"x-samplevalue":1602435436397,"format":"int64","type":"integer"},"elementInstanceId":{"x-samplevalue":910,"format":"int32","type":"integer"},"quartzJobName":{"type":"string"},"firstErrorStatusCode":{"x-samplevalue":404,"format":"int32","type":"integer"},"errorCount":{"x-samplevalue":100,"format":"int32","type":"integer"},"object":{"x-samplevalue":"itemCategories","type":"string"},"errorMessage":{"x-samplevalue":"{\"requestId\":\"5f8efc6fe4b03d2aa122cbcf\",\"message\":\"Element was not setup properly. This element does not return a root array for its pluralized responses, so a 'rootKey' field is needed to be set on this resource\"}","type":"string"}},"type":"object"},"InstancesPollingDisabled":{"type":"object","properties":{"id":{"x-samplevalue":910,"format":"int32","type":"integer"},"pollingErrorDetails":{"type":"array","items":{"$ref":"#/definitions/InstancesPollingDisabledPollingErrorDetails"}}}},"ElementInstanceValidatePostRes":{"title":"ElementInstanceValidatePostRes","properties":{"status":{"x-samplevalue":"started","type":"string"}},"type":"object"},"ElementInstanceValidateStatusInstancesHeartbeat":{"type":"object","title":"heartbeat","properties":{"providerErrorMessage":{"x-samplevalue":"string","type":"string"},"errorMessage":{"x-samplevalue":"string","type":"string"},"status":{"x-samplevalue":true,"type":"boolean"},"statusCode":{"x-samplevalue":400,"format":"int32","type":"integer"}}},"ElementInstanceValidateStatusInstances":{"title":"instances","properties":{"heartbeat":{"$ref":"#/definitions/ElementInstanceValidateStatusInstancesHeartbeat"},"heartbeatCheckTime":{"x-samplevalue":1613108638061,"format":"int64","type":"integer"},"id":{"x-samplevalue":401877,"format":"int32","type":"integer"}},"type":"object"},"ElementInstanceValidateStatus":{"title":"ElementInstanceValidateStatus","properties":{"instances":{"type":"array","items":{"$ref":"#/definitions/ElementInstanceValidateStatusInstances"}},"status":{"x-samplevalue":"completed","type":"string"},"triggeredUser":{"x-samplevalue":24425,"format":"int32","type":"integer"}},"type":"object"},"TraceLoggingConfig":{"properties":{"duration":{"type":"integer","description":"The duration, in minutes, to enable trace-level logging for. Defaults to 10 minutes."}},"type":"object"},"Definition":{"properties":{"fields":{"items":{"$ref":"#/definitions/Field"},"type":"array"}},"type":"object"},"ElementInstanceConfigUpdate":{"properties":{"propertyValue":{"type":"string"}},"required":["propertyValue"],"type":"object"},"validatePostReq":{"title":"validatePostReq","properties":{"instanceIds":{"x-samplevalue":"1049,1084","description":"comma seperated instanceIds","type":"string"}},"required":["instanceIds"],"type":"object"},"Transformation":{"properties":{"configuration":{"items":{"$ref":"#/definitions/Configuration"},"type":"array"},"fields":{"items":{"$ref":"#/definitions/TransformationField"},"type":"array"},"level":{"type":"string"},"startDate":{"type":"string"},"vendorName":{"type":"string"}},"type":"object"},"Customer-GET":{"x-has-customfields":false,"title":"ApiMetric","properties":{"environment":{"x-samplevalue":"test","type":"string"},"createdDate":{"x-samplevalue":"2018-04-24","x-mask":"yyyy-MM-dd","format":"date","type":"string"},"name":{"x-samplevalue":"my newer customer","type":"string"},"organizations":{"type":"array","items":{"$ref":"#/definitions/Organization-GET"}},"active":{"x-samplevalue":true,"type":"boolean"},"id":{"x-samplevalue":12,"format":"int32","type":"integer"},"updatedDate":{"x-samplevalue":"2018-04-24","x-mask":"yyyy-MM-dd","format":"date","type":"string"},"contacts":{"type":"array","items":{"$ref":"#/definitions/CustomerContact"}},"status":{"x-samplevalue":"trial","type":"string"}},"type":"object"},"CustomerContact":{"x-has-customfields":false,"title":"CustomerContact","properties":{"country":{"x-samplevalue":"USA","type":"string"},"createdDate":{"x-samplevalue":"2018-07-31","x-mask":"yyyy-MM-dd","format":"date","type":"string"},"phone":{"x-samplevalue":"123-456-7890","type":"string"},"city":{"x-samplevalue":"CO","type":"string"},"postalCode":{"x-samplevalue":"80000","type":"string"},"customerId":{"x-samplevalue":12,"format":"int32","type":"integer"},"name":{"x-samplevalue":"foo","type":"string"},"street1":{"x-samplevalue":"123 Any Street","type":"string"},"id":{"x-samplevalue":1,"format":"int32","type":"integer"},"street2":{"x-samplevalue":"AnySuite","type":"string"},"updatedDate":{"x-samplevalue":"2018-07-31","x-mask":"yyyy-MM-dd","format":"date","type":"string"},"email":{"x-sub-format":"email","x-samplevalue":"foo@bar.com","type":"string"}},"type":"object"},"Organization-POST":{"x-has-customfields":false,"type":"object","title":"Organization","properties":{"environment":{"x-samplevalue":"production","type":"string","enum":["production","test"]},"name":{"x-samplevalue":"My Organization","type":"string","description":"The name of the organization."},"externalId":{"x-samplevalue":"myid1234","type":"string","description":"Any identifying string."},"status":{"x-samplevalue":"paid","type":"string","description":"Whether the organization is paid or trial. Defaults to trial.","enum":["paid","trial"]},"roles":{"type":"array","items":{"$ref":"#/definitions/rolesCompanies-POST"}}}},"Organization-GET":{"x-has-customfields":false,"title":"Organization","properties":{"environment":{"x-samplevalue":"production","type":"string","enum":["production","test"]},"canCreatePeer":{"x-samplevalue":false,"type":"boolean"},"twoFactorAuthEnabled":{"x-samplevalue":false,"type":"boolean"},"tierId":{"x-samplevalue":0,"format":"int32","type":"integer"},"name":{"x-samplevalue":"My Organization","type":"string"},"customerId":{"x-samplevalue":15,"format":"int32","type":"integer"},"active":{"x-samplevalue":true,"type":"boolean"},"externalId":{"x-samplevalue":"myid1234","type":"string"},"id":{"x-samplevalue":71,"format":"int32","type":"integer"},"secret":{"x-samplevalue":"fecf0a0aeb81af1da1bb15b4034f516e","type":"string"},"vdrVersion":{"x-samplevalue":"v1","type":"string"},"status":{"x-samplevalue":"paid","type":"string","enum":["paid","trial"]},"street1":{"x-samplevalue":"123 Main St.","type":"string"},"city":{"x-samplevalue":"Anytown","type":"string"},"state":{"x-samplevalue":"CO","type":"string"},"postalCode":{"x-samplevalue":"90210","type":"string"},"country":{"x-samplevalue":"USA","type":"string"}},"type":"object"},"Account-POST":{"properties":{"description":{"type":"string"},"externalId":{"type":"string"},"name":{"type":"string"}},"type":"object"},"Account-GET":{"x-has-customfields":false,"title":"Account","properties":{"companyId":{"x-samplevalue":71,"format":"int32","type":"integer"},"createdDate":{"x-samplevalue":"2018-04-26","x-mask":"yyyy-MM-dd","format":"date","type":"string"},"name":{"x-samplevalue":"My account","type":"string"},"customerId":{"x-samplevalue":15,"format":"int32","type":"integer"},"customerName":{"x-samplevalue":"My customer","type":"string"},"active":{"x-samplevalue":true,"type":"boolean"},"description":{"x-samplevalue":"My account description","type":"string"},"externalId":{"x-samplevalue":"my-ext-id","type":"string"},"id":{"x-samplevalue":566,"format":"int32","type":"integer"},"defaultAccount":{"x-samplevalue":true,"type":"boolean"},"type":{"x-samplevalue":"CompanyAccount","type":"string"}},"type":"object"},"User-POST":{"x-has-customfields":false,"title":"User","properties":{"firstName":{"x-samplevalue":"John","type":"string"},"lastName":{"x-samplevalue":"Doe","type":"string"},"roles":{"type":"array","items":{"$ref":"#/definitions/roles-POST"}},"externalId":{"x-samplevalue":"USERID_18","type":"string"}},"type":"object"},"rolesCompanies-POST":{"x-has-customfields":false,"title":"roles","properties":{"key":{"x-samplevalue":"org-admin","type":"string"},"privileges":{"type":"array","items":{"$ref":"#/definitions/privileges-POST"}}},"required":["key","privileges"],"type":"object"},"roles-POST":{"x-has-customfields":false,"title":"roles","properties":{"key":{"x-samplevalue":"org-admin","type":"string"}},"type":"object"},"IdentityProvider-POST":{"properties":{"ssoUrl":{"type":"string","description":"The SSO URL."},"entityId":{"type":"string","description":"The unique identifier of the SAML entity."},"logonProtocolBinding":{"type":"string","description":"The protocol for logon binding. The only supported value is 'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect', and is the default.","enum":["urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect"]},"logoutUrl":{"type":"string","description":"The SSO logout URL."},"logoutProtocolBinding":{"type":"string","description":"The protocol for logout binding. The only supported value is 'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect', and is the default.","enum":["urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect"]},"logoutResponseUrl":{"type":"string","description":"The URL for logout response. Defaults to the value provided for 'logoutUrl'."},"idFormat":{"type":"string","description":"The format of the ID. Example: urn:oasis:names:tc:SAML:2.0:nameid-format:persistent","x-samplevalue":"urn:oasis:names:tc:SAML:2.0:nameid-format:persistent"},"signingCert":{"type":"string","description":"Public x509 certificate."},"signatureAlgorithm":{"type":"string","description":"The algorithm for use in the signing process.","enum":["rsa-sha1","rsa-sha256","rsa-sha384","rsa-sha512"]},"forceAuthentication":{"type":"boolean","description":"Optional toggle to specify the ForceAuthn parameter on the AuthnRequest. Defaults to true."}},"required":["ssoUrl","entityId","signingCert"],"type":"object"},"IdentityProvider-GET":{"properties":{"id":{"type":"integer","description":"The ID of the identity provider record."},"ssoUrl":{"type":"string","description":"The SSO URL."},"entityId":{"type":"string","description":"The unique identifier of the SAML entity."},"logonProtocolBinding":{"type":"string","description":"The protocol for logon binding. The only supported value is 'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect', and is the default.","enum":["urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect"]},"logoutUrl":{"type":"string","description":"The SSO logout URL."},"logoutProtocolBinding":{"type":"string","description":"The protocol for logout binding. The only supported value is 'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect', and is the default.","enum":["urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect"]},"logoutResponseUrl":{"type":"string","description":"The URL for logout response. Defaults to the value provided for 'logoutUrl'."},"idFormat":{"type":"string","description":"The format of the ID. Example: urn:oasis:names:tc:SAML:2.0:nameid-format:persistent","x-samplevalue":"urn:oasis:names:tc:SAML:2.0:nameid-format:persistent"},"signingCert":{"type":"string","description":"Public x509 certificate."},"signatureAlgorithm":{"type":"string","description":"The algorithm for use in the signing process.","enum":["rsa-sha1","rsa-sha256","rsa-sha384","rsa-sha512"]},"createdDate":{"x-samplevalue":"2018-05-18","x-mask":"yyyy-MM-dd","format":"date","type":"string"},"forceAuthentication":{"type":"boolean","description":"Optional toggle to specify the ForceAuthn parameter on the AuthnRequest. Defaults to true."}},"required":["ssoUrl","entityId","signingCert"],"type":"object"},"CustomerSignup-POST":{"properties":{"organization":{"$ref":"#/definitions/Organization-POST"},"account":{"$ref":"#/definitions/Account-POST"},"user":{"$ref":"#/definitions/User-POST"}},"type":"object"},"CustomerSignup-GET":{"properties":{"organization":{"$ref":"#/definitions/Organization-GET"},"account":{"$ref":"#/definitions/Account-GET"},"user":{"$ref":"#/definitions/User-GET"}},"type":"object"},"User-GET":{"x-has-customfields":false,"title":"User","properties":{"accountLocked":{"x-samplevalue":false,"type":"boolean"},"lastName":{"x-samplevalue":"Doe","type":"string"},"roles":{"type":"array","items":{"$ref":"#/definitions/roles-GET"}},"credentialsNonExpired":{"x-samplevalue":false,"type":"boolean"},"active":{"x-samplevalue":true,"type":"boolean"},"externalId":{"x-samplevalue":"myid1234","type":"string"},"fullName":{"x-samplevalue":"John Doe","type":"string"},"secret":{"x-samplevalue":"a3tzhodnBSXduOj1q5lDpnHdPeb/9DWt1PO5sYLjpc7=","type":"string"},"userSecretKeystring":{"x-samplevalue":"hzr6EirHepDnn/64i7b5qXxo3YHgWJYzt8+lOUPkYys=","type":"string"},"enabled":{"x-samplevalue":true,"type":"boolean"},"firstName":{"x-samplevalue":"John","type":"string"},"emailValid":{"x-samplevalue":true,"type":"boolean"},"accountExpired":{"x-samplevalue":false,"type":"boolean"},"accountNonExpired":{"x-samplevalue":true,"type":"boolean"},"id":{"x-samplevalue":784,"format":"int32","type":"integer"},"credentialsExpired":{"x-samplevalue":true,"type":"boolean"},"email":{"x-samplevalue":"john.doe@example.com","type":"string"},"accountNonLocked":{"x-samplevalue":true,"type":"boolean"}},"type":"object"},"privileges-POST":{"x-has-customfields":false,"title":"privileges","properties":{"key":{"x-samplevalue":"viewElements","type":"string"}},"type":"object"},"privileges-GET":{"x-has-customfields":false,"title":"privileges","properties":{"hide":{"x-samplevalue":false,"type":"boolean"},"createdDate":{"x-samplevalue":"2017-12-06","x-mask":"yyyy-MM-dd","format":"date","type":"string"},"name":{"x-samplevalue":"View Elements","type":"string"},"active":{"x-samplevalue":true,"type":"boolean"},"description":{"x-samplevalue":"The ability to view elements","type":"string"},"id":{"x-samplevalue":1,"format":"int32","type":"integer"},"category":{"x-samplevalue":"Elements","type":"string"},"key":{"x-samplevalue":"viewElements","type":"string"}},"type":"object"},"roles-GET":{"x-has-customfields":false,"title":"roles","properties":{"privileges":{"type":"array","items":{"$ref":"#/definitions/privileges-GET"}},"hide":{"x-samplevalue":false,"type":"boolean"},"name":{"x-samplevalue":"Organization User","type":"string"},"active":{"x-samplevalue":true,"type":"boolean"},"description":{"x-samplevalue":"Organization User","type":"string"},"id":{"x-samplevalue":32,"format":"int32","type":"integer"},"key":{"x-samplevalue":"org","type":"string"}},"type":"object"},"Organization":{"properties":{"externalId":{"type":"string"},"name":{"type":"string"}},"type":"object"},"Account":{"description":"A account object. With the exception of the 'id' field, the required fields indicated are those required to create a new account. For other account operations, the required fields will be a subset of these fields. There will be other fields returned with a Account, which are not all described here.","properties":{"billingAddress":{"$ref":"#/definitions/Address"},"id":{"type":"string"},"name":{"type":"string"},"numberOfEmployees":{"type":"integer"},"parentId":{"type":"string"},"phone":{"type":"string"},"shippingAddress":{"$ref":"#/definitions/Address"},"type":{"type":"string"},"website":{"type":"string"}},"required":["name"],"type":"object"},"ConfigurationProperty":{"properties":{"key_placeholder":{"description":"configuration property place holder","type":"string"}},"type":"object"},"DefinitionField":{"properties":{"path":{"type":"string"},"type":{"type":"string"}},"type":"object"},"Dictionary":{"properties":{"object_name_placeholder":{"description":"Dictionary object name place holder","$ref":"#/definitions/Definition"},"level":{"type":"string"}},"type":"object"},"TransformationField":{"properties":{"configuration":{"items":{"$ref":"#/definitions/Configuration"},"type":"array"},"path":{"type":"string"},"type":{"type":"string"},"vendorPath":{"type":"string"},"vendorType":{"type":"string"}},"type":"object"},"TransformationLibrary":{"properties":{"object_name_placeholder":{"description":"Dictionary object name place holder","$ref":"#/definitions/Transformation"}},"type":"object"},"TransformationMetadata":{"properties":{"account":{"$ref":"#/definitions/TransformationAccount"},"element":{"$ref":"#/definitions/TransformationElement"},"level":{"type":"string"},"name":{"type":"string"}},"type":"object"},"OrganizationStatus-PUT":{"properties":{"active":{"type":"boolean"}},"type":"object"},"Account-PUT":{"properties":{"active":{"type":"boolean"},"description":{"type":"string"},"externalId":{"type":"string"},"name":{"type":"string"}},"type":"object"},"AllInstancesFormula":{"properties":{"accountId":{"description":"The account ID that owns the formula instance.","type":"integer"},"active":{"description":"Whether this formula is active or not.","type":"boolean"},"configuration":{"items":{"$ref":"#/definitions/GetConfiguration"},"type":"array"},"createdDate":{"type":"string","format":"date-time","description":"The date and time the formula template was created, in ISO-8601 format (e.g. 2015-09-08T21:31:42Z)."},"description":{"description":"The description of what this formula does.","type":"string"},"id":{"description":"The ID of the formula template.","type":"integer"},"name":{"description":"The name of the formula template (e.g. CRM --> Marketing). The name must be unique.","type":"string"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time the formula template was last updated, in ISO-8601 format (e.g. 2015-09-08T21:31:42Z)."},"userId":{"description":"The user ID that owns the formula instance.","type":"integer"}},"required":["name"],"type":"object"},"FormulaInstance":{"properties":{"active":{"description":"Whether this formula instance is active or not.","type":"boolean"},"configuration":{"$ref":"#/definitions/FormulaInstanceConfiguration","description":"The configuration key/value pairs."},"settings":{"$ref":"#/definitions/FormulaInstanceSettings","description":"The setting key/value pairs."},"createdDate":{"type":"string","format":"date-time","description":"The date and time the formula instance was created, in ISO-8601 format (e.g. 2015-09-08T21:31:42Z)."},"formula":{"$ref":"#/definitions/FormulaInstanceFormula","description":"The formula that this instance was created from."},"name":{"description":"The name of the formula instance.","type":"string"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time the formula instance was last updated, in ISO-8601 format (e.g. 2015-09-08T21:31:42Z)."}},"required":["name","formula"],"type":"object"},"TransformationAccount":{"properties":{"defaultAccount":{"type":"boolean"},"externalId":{"type":"string"},"id":{"type":"string"}},"type":"object"},"TransformationElement":{"properties":{"hub":{"type":"string"},"id":{"type":"number"},"image":{"type":"string"},"key":{"type":"string"},"name":{"type":"string"},"trialAccount":{"type":"boolean"},"typeOauth":{"type":"boolean"}},"type":"object"},"Role-PUT":{"x-has-customfields":false,"title":"role","properties":{"key":{"x-samplevalue":"org-admin","type":"string"}},"type":"object"},"User-PUT":{"x-has-customfields":false,"title":"User-PUT","properties":{"country":{"x-samplevalue":"USA","type":"string"},"lastName":{"x-samplevalue":"User","type":"string"},"city":{"x-samplevalue":"Anytown","type":"string"},"postalCode":{"x-samplevalue":"80000","type":"string"},"roles":{"type":"array","items":{"$ref":"#/definitions/Role-PUT"}},"stateProvince":{"x-samplevalue":"CO","type":"string"},"active":{"x-samplevalue":true,"type":"boolean"},"externalId":{"x-samplevalue":"USERID_20","type":"string"},"firstName":{"x-samplevalue":"SAP","type":"string"},"phone":{"x-samplevalue":"123-456-7890","type":"string"},"street1":{"x-samplevalue":"123 Main St.","type":"string"},"street2":{"x-samplevalue":"Apt 1","type":"string"},"email":{"x-samplevalue":"USERID_23@597.67.generated","type":"string"}},"type":"object"},"Role":{"properties":{"active":{"type":"boolean"},"description":{"type":"string"},"features":{"type":"array","items":{"$ref":"#/definitions/Feature"}},"id":{"type":"number"},"key":{"type":"string"},"name":{"type":"string"}},"type":"object"},"Feature":{"properties":{"active":{"type":"boolean"},"createdDate":{"format":"date-time","type":"string"},"description":{"type":"string"},"id":{"type":"number"},"readOnly":{"type":"boolean"},"name":{"type":"string"}},"type":"object"},"PasswordReset-POST":{"properties":{"password":{"type":"string","description":"The password."}},"type":"object"},"Privilege":{"x-has-customfields":false,"title":"privileges","properties":{"hide":{"x-samplevalue":false,"type":"boolean"},"createdDate":{"x-samplevalue":"2017-12-06","x-mask":"yyyy-MM-dd","format":"date","type":"string"},"name":{"x-samplevalue":"View Elements","type":"string"},"active":{"x-samplevalue":true,"type":"boolean"},"description":{"x-samplevalue":"The ability to view elements","type":"string"},"id":{"x-samplevalue":1,"format":"int32","type":"integer"},"category":{"x-samplevalue":"Elements","type":"string"},"key":{"x-samplevalue":"viewElements","type":"string"}},"type":"object"},"AuthenticatedUser-GET":{"x-has-customfields":false,"title":"AuthenticatedUser-GET","properties":{"lastName":{"x-samplevalue":"User","type":"string"},"registeredForTwoFactor":{"x-samplevalue":false,"type":"boolean"},"twoFactor":{"x-samplevalue":false,"type":"boolean"},"organizationName":{"x-samplevalue":"Cloud Elements","type":"string"},"accountName":{"x-samplevalue":"Cloud Elements Default Account","type":"string"},"roles":{"type":"array","items":{"$ref":"#/definitions/AuthenticatedUserRole"}},"lastLoginDate":{"x-samplevalue":"2018-05-22","x-mask":"yyyy-MM-dd","format":"date","type":"string"},"organizationAdmin":{"x-samplevalue":true,"type":"boolean"},"token":{"x-samplevalue":"A/Ilvfo9Oj1nBHhAGohn7/131m3dJG8BVVNJ+OYrYkKep8Z13CHipgY0TlZXAZrEIAYqhspbTvgv8bhJuhWhmNa5spEKV9AaUoserkRCKwJTb8oEQLy+gZ1BLJxsMYxb9BW/bEthp5TSwNYjP0/YjdAoX+ffRKkwOv/SKu1HUOBIxMdRSEfQpxeUMwyQDHgLSrtpCcIvEbF1S3P0jinBgu8UiHws7rTwsyQQGf7T89spgz7lT43Xxsnakhg53xCqnXd0pwkseHIOmqeof7TpA7ux6kxf39KVpJvxagp0Zjm62FPkXuegISZvIk9/Oyh+lZxzkNmZ3n1zUBoQGBXnoqiH0x+5CkudrwAm029QuBDuBsvLIlRK3YZrFWSyg0r/fWnP7DmA4E9u3uhU","type":"string"},"organizationId":{"x-samplevalue":1,"format":"int32","type":"integer"},"accountId":{"x-samplevalue":1,"format":"int32","type":"integer"},"firstName":{"x-samplevalue":"Default System","type":"string"},"createdDate":{"x-samplevalue":"2014-06-19","x-mask":"yyyy-MM-dd","format":"date","type":"string"},"inIntelligenceRole":{"x-samplevalue":true,"type":"boolean"},"id":{"x-samplevalue":1,"format":"int32","type":"integer"},"sysAdmin":{"x-samplevalue":true,"type":"boolean"},"accountAdmin":{"x-samplevalue":true,"type":"boolean"},"username":{"x-samplevalue":"system","type":"string"}},"type":"object"},"AuthenticatedUserRole":{"x-has-customfields":false,"title":"roles","properties":{"features":{"type":"array","items":{"$ref":"#/definitions/Feature"}},"privileges":{"type":"array","items":{"$ref":"#/definitions/Privilege"}},"hide":{"x-samplevalue":false,"type":"boolean"},"name":{"x-samplevalue":"Default User","type":"string"},"active":{"x-samplevalue":true,"type":"boolean"},"description":{"x-samplevalue":"Default User","type":"string"},"id":{"x-samplevalue":36,"format":"int32","type":"integer"},"key":{"x-samplevalue":"default-user","type":"string"}},"type":"object"},"Hub":{"properties":{"description":{"type":"string"},"id":{"type":"number"},"key":{"type":"string"},"name":{"type":"string"}},"type":"object"},"ApiMetric":{"title":"ApiMetric","type":"object","properties":{"count":{"x-samplevalue":19,"format":"int32","type":"integer"},"id":{"x-samplevalue":529,"format":"int32","type":"integer"},"interval":{"x-samplevalue":"hour","type":"string"},"externalId":{"x-samplevalue":"my-ext-id","type":"string"},"metrics":{"type":"array","items":{"$ref":"#/definitions/ApiMetricsMetrics"}}},"x-has-customfields":false},"ApiMetrics":{"type":"array","items":{"$ref":"#/definitions/ApiMetric"}},"ApiMetricsDetail":{"x-has-customfields":false,"title":"details","properties":{"count":{"x-samplevalue":2,"format":"int32","type":"integer"},"type":{"x-samplevalue":"platform","type":"string"}},"type":"object"},"ApiMetricsMetrics":{"x-has-customfields":false,"title":"metrics","properties":{"count":{"x-samplevalue":0,"format":"int32","type":"integer"},"details":{"type":"array","items":{"$ref":"#/definitions/ApiMetricsDetail"}},"timestamp":{"x-samplevalue":"2018-05-13T23:00:00.000Z","x-mask":"yyyy-MM-dd'T'HH:mm:ss.SSSZ","format":"date-time","type":"string"}},"type":"object"},"HubMetric":{"title":"HubMetric","type":"object","properties":{"count":{"x-samplevalue":19,"format":"int32","type":"integer"},"id":{"x-samplevalue":529,"format":"int32","type":"integer"},"interval":{"x-samplevalue":"hour","type":"string"},"externalId":{"x-samplevalue":"my-ext-id","type":"string"},"metrics":{"type":"array","items":{"$ref":"#/definitions/HubMetricsMetrics"}}},"x-has-customfields":false},"HubMetrics":{"type":"array","items":{"$ref":"#/definitions/HubMetric"}},"HubMetricsDetail":{"x-has-customfields":false,"title":"details","properties":{"count":{"x-samplevalue":2,"format":"int32","type":"integer"},"hub":{"x-samplevalue":"crm","type":"string"}},"type":"object"},"HubMetricsMetrics":{"x-has-customfields":false,"title":"metrics","properties":{"count":{"x-samplevalue":0,"format":"int32","type":"integer"},"details":{"type":"array","items":{"$ref":"#/definitions/HubMetricsDetail"}},"timestamp":{"x-samplevalue":"2018-05-13T23:00:00.000Z","x-mask":"yyyy-MM-dd'T'HH:mm:ss.SSSZ","format":"date-time","type":"string"}},"type":"object"},"ElementInstancesCreatedMetric":{"title":"ElementInstancesCreatedMetric","type":"object","properties":{"count":{"x-samplevalue":19,"format":"int32","type":"integer"},"id":{"x-samplevalue":529,"format":"int32","type":"integer"},"interval":{"x-samplevalue":"hour","type":"string"},"externalId":{"x-samplevalue":"my-ext-id","type":"string"},"metrics":{"type":"array","items":{"$ref":"#/definitions/ElementInstancesCreatedMetricsMetrics"}}},"x-has-customfields":false},"ElementInstancesCreatedMetrics":{"type":"array","items":{"$ref":"#/definitions/ElementInstancesCreatedMetric"}},"ElementInstancesCreatedMetricsDetail":{"x-has-customfields":false,"title":"details","properties":{"count":{"x-samplevalue":2,"format":"int32","type":"integer"},"elementKey":{"x-samplevalue":"closeio","type":"string"}},"type":"object"},"ElementInstancesCreatedMetricsMetrics":{"x-has-customfields":false,"title":"metrics","properties":{"count":{"x-samplevalue":0,"format":"int32","type":"integer"},"details":{"type":"array","items":{"$ref":"#/definitions/ElementInstancesCreatedMetricsDetail"}},"timestamp":{"x-samplevalue":"2018-05-13T23:00:00.000Z","x-mask":"yyyy-MM-dd'T'HH:mm:ss.SSSZ","format":"date-time","type":"string"}},"type":"object"},"BulkMetric":{"title":"BulkMetric","type":"object","properties":{"count":{"x-samplevalue":19,"format":"int32","type":"integer"},"id":{"x-samplevalue":529,"format":"int32","type":"integer"},"interval":{"x-samplevalue":"hour","type":"string"},"externalId":{"x-samplevalue":"my-ext-id","type":"string"},"metrics":{"type":"array","items":{"$ref":"#/definitions/BulkMetricsMetrics"}}},"x-has-customfields":false},"BulkMetrics":{"type":"array","items":{"$ref":"#/definitions/BulkMetric"}},"BulkMetricsDetail":{"x-has-customfields":false,"title":"details","properties":{"count":{"x-samplevalue":2,"format":"int32","type":"integer"},"direction":{"x-samplevalue":"download","type":"string"},"records":{"x-samplevalue":5,"format":"int32","type":"integer"}},"type":"object"},"BulkMetricsMetrics":{"x-has-customfields":false,"title":"metrics","properties":{"count":{"x-samplevalue":2,"format":"int32","type":"integer"},"details":{"type":"array","items":{"$ref":"#/definitions/BulkMetricsDetail"}},"timestamp":{"x-samplevalue":"2018-05-13T23:00:00.000Z","x-mask":"yyyy-MM-dd'T'HH:mm:ss.SSSZ","format":"date-time","type":"string"}},"type":"object"},"Metric":{"title":"Metric","type":"object","properties":{"count":{"x-samplevalue":19,"format":"int32","type":"integer"},"id":{"x-samplevalue":529,"format":"int32","type":"integer"},"interval":{"x-samplevalue":"hour","type":"string"},"externalId":{"x-samplevalue":"my-ext-id","type":"string"},"metrics":{"type":"array","items":{"$ref":"#/definitions/MetricsMetrics"}}},"x-has-customfields":false},"Metrics":{"type":"array","items":{"$ref":"#/definitions/Metric"}},"MetricsMetrics":{"x-has-customfields":false,"title":"metrics","properties":{"count":{"x-samplevalue":"0","format":"int32","type":"integer"},"timestamp":{"x-samplevalue":"2018-05-13T23:00:00.000Z","x-mask":"yyyy-MM-dd'T'HH:mm:ss.SSSZ","format":"date-time","type":"string"}},"type":"object"},"ActivityElementEntry":{"properties":{"elementKey_placeholder":{"description":"Activity element entry place holder","type":"integer"},"count":{"type":"integer"},"timestamp":{"format":"date-time","type":"string"}},"type":"object"},"ActivityEntry":{"properties":{"count":{"type":"integer"},"timestamp":{"format":"date-time","type":"string"}},"type":"object"},"StatusEntry":{"properties":{"count":{"type":"integer"},"failed":{"type":"integer"},"success":{"type":"integer"},"timestamp":{"format":"date-time","type":"string"}},"type":"object"},"TimesEntry":{"properties":{"avg":{"type":"integer"},"count":{"type":"integer"},"max":{"type":"integer"},"min":{"type":"integer"},"timestamp":{"format":"date-time","type":"string"}},"type":"object"},"TrafficEntry":{"properties":{"accountId":{"type":"integer"},"companyId":{"type":"integer"},"elementKey":{"type":"string"},"elementName":{"type":"string"},"elementTags":{"type":"string"},"id":{"type":"string"},"instanceName":{"type":"string"},"processTime":{"type":"integer"},"requestIP":{"type":"integer"},"requestStatus":{"type":"string"},"requestURI":{"type":"string"},"usageDate":{"format":"date-time","type":"string"},"userId":{"type":"integer"}},"type":"object"},"AnalyticsPercentiles":{"properties":{"1.0":{"type":"number"},"5.0":{"type":"number"},"25.0":{"type":"number"},"50.0":{"type":"number"},"75.0":{"type":"number"},"95.0":{"type":"number"},"99.0":{"type":"number"}},"type":"object"},"AnalyticEntry":{"properties":{"avg":{"type":"number"},"sum":{"type":"integer"},"percentiles":{"$ref":"#/definitions/AnalyticsPercentiles"}},"type":"object"},"StatusAnalyticsEntry":{"properties":{"success":{"type":"integer"},"failed":{"type":"integer"},"timestamp":{"format":"date-time","type":"string"}},"type":"object"},"StatusNowEntry":{"properties":{"accountId":{"type":"integer"},"success":{"type":"integer"},"failed":{"type":"integer"},"pending":{"type":"integer"},"canceled":{"type":"integer"},"unknown":{"type":"integer"},"retries":{"type":"array","items":{"$ref":"#/definitions/StatusRetryRecord"}}},"type":"object"},"StatusRetryRecord":{"properties":{"executionId":{"type":"integer"},"retry":{"type":"integer"}},"type":"object"},"StepAnalyticsEntry":{"properties":{"count":{"type":"integer"},"timestamp":{"format":"date-time","type":"string"},"executionTime":{"description":"The average, sum, and percentiles for the step execution time over the specified period.","$ref":"#/definitions/AnalyticEntry"},"executionDelay":{"description":"The average, sum, and percentiles for the step execution delay over the specified period.","$ref":"#/definitions/AnalyticEntry"},"contextSize":{"description":"The average, sum, and percentiles for the step execution context size over the specified period.","$ref":"#/definitions/AnalyticEntry"}},"type":"object"},"CreateConfiguration":{"properties":{"description":{"description":"The description of the configuration item.","type":"string"},"key":{"description":"The key of the configuration item (e.g. 'sfdc.instance.id' to identify a Salesforce.com instance ID).","type":"string"},"name":{"description":"The name of the configuration item.","type":"string"},"type":{"description":"The type of the configuration item.
value: A string value.
elementInstance: An element instance.","enum":["value","elementInstance"],"type":"string"}},"required":["name","key","type"],"type":"object"},"CreateFormula":{"properties":{"active":{"description":"Whether this formula template is active or not.","type":"boolean"},"configuration":{"items":{"$ref":"#/definitions/Configuration"},"type":"array"},"description":{"description":"The description of what this formula does.","type":"string"},"name":{"description":"The name of the formula template (e.g. CRM --> Marketing). The name must be unique.","type":"string"},"steps":{"items":{"$ref":"#/definitions/Step"},"type":"array"},"triggers":{"items":{"$ref":"#/definitions/Trigger"},"type":"array"}},"required":["name"],"type":"object"},"CreateFormulaInstance":{"properties":{"active":{"description":"Whether this formula instance is active or not.","type":"boolean"},"configuration":{"$ref":"#/definitions/FormulaInstanceConfiguration","description":"The configuration key/value pairs required by the formula template."},"settings":{"$ref":"#/definitions/FormulaInstanceSettings","description":"The setting key/value pairs."},"name":{"description":"The name of the formula instance.","type":"string"}},"required":["name"],"type":"object"},"CreateStep":{"properties":{"name":{"description":"The name of the step.","type":"string"},"onFailure":{"description":"The list of step names to execute upon failure of this step.","items":{"type":"string"},"type":"array"},"onSuccess":{"description":"The list of step names to execute upon success of this step.","items":{"type":"string"},"type":"array"},"properties":{"$ref":"#/definitions/Properties"},"type":{"description":"The type of the step.","enum":["request","elementRequest","transform","filter","script"],"type":"string"}},"required":["name","type"],"type":"object"},"CreateTrigger":{"type":"object","properties":{"cron":{"type":"string"}}},"FormulaExecution":{"properties":{"createdDate":{"type":"string","format":"date-time","description":"The date and time the execution was started, in ISO-8601 format (e.g. 2015-09-08T21:31:42Z)."},"formulaInstanceId":{"description":"The ID of the formula instance.","type":"integer"},"status":{"description":"The status of this execution.","type":"string","enum":["failed","success","pending","queued","cancelled","unknown"]},"id":{"description":"The ID of the execution.","type":"integer"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time the execution was last updated, in ISO-8601 format (e.g. 2015-09-08T21:31:42Z)."}},"type":"object"},"FormulaExecutionBody":{},"FormulaInstanceConfiguration":{"properties":{"key_placeholder":{"default":"value","description":"The key of the configuration item (e.g. 'sfdc.instance.id' to identify a Salesforce.com instance ID). Replace '' with the actual key to be used. The value will be the value that the key should use for this instance.","type":"string"}},"type":"object"},"FormulaInstanceSettings":{"properties":{"notification.email":{"description":"A list of comma separated email address that will receive formula error notifications.","type":"string"},"notification.webhook.url":{"description":"A list of comma separated URLs that will receive formula error notifications.","type":"string"},"attribute.log.mask":{"description":"A list of comma separated properties whose values will be masked in log output.","type":"string"},"api":{"description":"The API, formatted like VERB /URI (GET /myResource), where this formula instance will be exposed to be executed as a synchronous API call","type":"string"}},"type":"object"},"FormulaInstanceFormula":{"properties":{"active":{"description":"Whether the formula is active or not.","type":"boolean"},"id":{"description":"The ID of the formula.","type":"integer"}},"required":["id"],"type":"object"},"FormulaInstanceStatus":{"properties":{"status":{"description":"Intended status of formula instance execution.","type":"string","enum":["cancelled"]}},"required":["status"],"type":"object"},"GetAllFormulaInstances":{"properties":{"active":{"description":"Whether this formula instance is active or not.","type":"boolean"},"configuration":{"$ref":"#/definitions/FormulaInstanceConfiguration","description":"The configuration key/value pairs."},"settings":{"$ref":"#/definitions/FormulaInstanceSettings","description":"The setting key/value pairs."},"createdDate":{"type":"string","format":"date-time","description":"The date and time the formula instance was created, in ISO-8601 format (e.g. 2015-09-08T21:31:42Z)."},"formula":{"$ref":"#/definitions/AllInstancesFormula","description":"The formula that this instance was created from."},"id":{"description":"The ID of the formula instance.","type":"integer"},"name":{"description":"The name of the formula instance.","type":"string"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time the formula instance was last updated, in ISO-8601 format (e.g. 2015-09-08T21:31:42Z)."}},"required":["name","formula"],"type":"object"},"GetAllFormulaExecutionErrors":{"properties":{"id":{"description":"The ID of the formula instance.","type":"integer"},"formula":{"$ref":"#/definitions/FormulaInstanceFormula","description":"The formula that this instance was created from."},"executions":{"description":"The formula instance executions. A maximum of 20 executions will be returned per formula instance.","type":"array","items":{"$ref":"#/definitions/GetAllInstanceExecutionErrors"}}},"type":"object"},"GetAllInstanceExecutionErrors":{"properties":{"status":{"description":"The status of this execution.","type":"string","enum":["failed","success","pending","queued","unknown"]},"createdDate":{"type":"string","format":"date-time","description":"The date and time the formula instance execution was created, in ISO-8601 format (e.g. 2015-09-08T21:31:42Z)."},"id":{"description":"The ID of the formula instance execution.","type":"integer"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time the formula instance execution was last updated, in ISO-8601 format (e.g. 2015-09-08T21:31:42Z)."},"stepExecutions":{"type":"array","items":{"$ref":"#/definitions/StepExecution"}}},"type":"object"},"GetConfiguration":{"properties":{"description":{"description":"The description of the configuration item.","type":"string"},"id":{"description":"The configuration ID.","type":"integer"},"key":{"description":"The key of the configuration item (e.g. 'sfdc.instance.id' to identify a Salesforce.com instance ID).","type":"string"},"name":{"description":"The name of the configuration item.","type":"string"},"type":{"description":"The type of the configuration item.
value: A string value.
elementInstance: An element instance.","enum":["value","elementInstance"],"type":"string"}},"required":["id","name","key","type"],"type":"object"},"GetFormula":{"properties":{"accountId":{"description":"The account ID that owns the formula instance.","type":"integer"},"active":{"description":"Whether this formula is active or not.","type":"boolean"},"configuration":{"items":{"$ref":"#/definitions/GetConfiguration"},"type":"array"},"createdDate":{"type":"string","format":"date-time","description":"The date and time the formula template was created, in ISO-8601 format (e.g. 2015-09-08T21:31:42Z)."},"description":{"description":"The description of what this formula does.","type":"string"},"id":{"description":"The ID of the formula.","type":"integer"},"name":{"description":"The name of the formula template (e.g. CRM --> Marketing). The name must be unique.","type":"string"},"steps":{"items":{"$ref":"#/definitions/GetStep"},"type":"array"},"triggers":{"items":{"$ref":"#/definitions/GetTrigger"},"type":"array"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time the formula template was last updated, in ISO-8601 format (e.g. 2015-09-08T21:31:42Z)."},"userId":{"description":"The user ID that owns the formula instance.","type":"integer"}},"required":["name"],"type":"object"},"GetFormulaSlim":{"properties":{"accountId":{"description":"The account ID that owns the formula instance.","type":"integer"},"active":{"description":"Whether this formula is active or not.","type":"boolean"},"createdDate":{"type":"string","format":"date-time","description":"The date and time the formula template was created, in ISO-8601 format (e.g. 2015-09-08T21:31:42Z)."},"description":{"description":"The description of what this formula does.","type":"string"},"id":{"description":"The ID of the formula.","type":"integer"},"name":{"description":"The name of the formula template (e.g. CRM --> Marketing). The name must be unique.","type":"string"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time the formula template was last updated, in ISO-8601 format (e.g. 2015-09-08T21:31:42Z)."},"userId":{"description":"The user ID that owns the formula instance.","type":"integer"}},"required":["id","name"],"type":"object"},"GetFormulaExecution":{"properties":{"createdDate":{"type":"string","format":"date-time","description":"The date and time the execution was started, in ISO-8601 format (e.g. 2015-09-08T21:31:42Z)."},"formulaInstanceId":{"description":"The ID of the formula instance.","type":"integer"},"id":{"description":"The ID of the execution.","type":"integer"},"status":{"description":"The status of this execution.","type":"string","enum":["failed","success","pending","queued","unknown"]},"stepExecutions":{"description":"The execution steps.","items":{"$ref":"#/definitions/StepExecution"},"type":"array"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time the execution was last updated, in ISO-8601 format (e.g. 2015-09-08T21:31:42Z)."}},"type":"object"},"GetFormulaFormulaInstance":{"properties":{"active":{"description":"Whether this formula instance is active or not.","type":"boolean"},"configuration":{"$ref":"#/definitions/FormulaInstanceConfiguration","description":"The configuration key/value pairs."},"settings":{"$ref":"#/definitions/FormulaInstanceSettings","description":"The setting key/value pairs."},"createdDate":{"type":"string","format":"date-time","description":"The date and time the formula instance was created, in ISO-8601 format (e.g. 2015-09-08T21:31:42Z)."},"formula":{"$ref":"#/definitions/GetInstanceFormula","description":"The formula that this instance was created from."},"id":{"description":"The ID of the formula instance.","type":"integer"},"name":{"description":"The name of the formula instance.","type":"string"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time the formula instance was last updated, in ISO-8601 format (e.g. 2015-09-08T21:31:42Z)."}},"required":["name","formula"],"type":"object"},"GetFormulaInstance":{"properties":{"active":{"description":"Whether this formula instance is active or not.","type":"boolean"},"configuration":{"$ref":"#/definitions/FormulaInstanceConfiguration","description":"The configuration key/value pairs."},"settings":{"$ref":"#/definitions/FormulaInstanceSettings","description":"The setting key/value pairs."},"createdDate":{"type":"string","format":"date-time","description":"The date and time the formula instance was created, in ISO-8601 format (e.g. 2015-09-08T21:31:42Z)."},"formula":{"$ref":"#/definitions/FormulaInstanceFormula","description":"The formula that this instance was created from."},"id":{"description":"The ID of the formula instance.","type":"integer"},"name":{"description":"The name of the formula instance.","type":"string"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time the formula instance was last updated, in ISO-8601 format (e.g. 2015-09-08T21:31:42Z)."}},"required":["name","formula"],"type":"object"},"GetInstanceFormula":{"properties":{"accountId":{"description":"The account ID that owns the formula instance.","type":"integer"},"active":{"description":"Whether the formula is active or not.","type":"boolean"},"createdDate":{"type":"string","format":"date-time","description":"The date and time the formula template was created, in ISO-8601 format (e.g. 2015-09-08T21:31:42Z)."},"description":{"description":"The description of the formula.","type":"string"},"id":{"description":"The ID of the formula.","type":"integer"},"name":{"description":"The name of the formula.","type":"string"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time the formula template was last updated, in ISO-8601 format (e.g. 2015-09-08T21:31:42Z)."},"userId":{"description":"The user ID that owns the formula instance.","type":"integer"}},"required":["id"],"type":"object"},"GetStep":{"properties":{"id":{"description":"The ID of the step.","type":"integer"},"name":{"description":"The name of the step.","type":"string"},"onFailure":{"description":"The list of step names to execute upon failure of this step.","items":{"type":"string"},"type":"array"},"onSuccess":{"description":"The list of step names to execute upon success of this step.","items":{"type":"string"},"type":"array"},"properties":{"$ref":"#/definitions/Properties"},"type":{"description":"The type of the step.","enum":["request","elementRequest","transform","filter","script"],"type":"string"}},"required":["id","name","type"],"type":"object"},"GetTrigger":{"properties":{"async":{"description":"Whether the trigger is asynchronous or not.","type":"boolean"},"id":{"description":"The ID of the trigger.","type":"integer"},"onFailure":{"description":"A list of step names to execute upon trigger failure.","items":{"type":"string"},"type":"array"},"onSuccess":{"description":"A list of step names to execute upon trigger success.","items":{"type":"string"},"type":"array"},"properties":{"$ref":"#/definitions/Properties"},"type":{"description":"The type of trigger.
elementRequest: A request made to an element instance. For this trigger type, Property objects of type 'api', 'method', and 'elementInstanceId' are required.
request: A non-instance API request (i.e platform APIs). For this trigger type, Property objects of type 'api' and 'method' are required.
event: An event from an instance. Note that events must be enabled on the instance for this trigger to work. For this trigger type, a Property of type 'elementInstanceId' is required.","enum":["elementRequest","request","event"],"type":"string"}},"required":["type","properties","onSuccess"],"type":"object"},"Properties":{"properties":{"api":{"description":"The API endpoint to call (e.g. /hubs/crm/contacts).","type":"string"},"body":{"description":"The body of a script for a script step. Or the body of an API call.","type":"string"},"elementInstanceId":{"description":"The element instance ID.","type":"string"},"headers":{"description":"The headers to send with an API call.","type":"string"},"method":{"description":"The method to use for an API call.","enum":["GET","POST","PATCH","PUT","DELETE"],"type":"string"},"mimeType":{"description":"The mime type to use for a script step (currently only 'application/javascript' is supported).","type":"string"},"path":{"description":"The source for replacement of path variables in an API step. This points to a previous step's return object, or a trigger object.","type":"string"},"query":{"description":"Query parameters for an API call.","type":"string"}},"type":"object"},"Step":{"properties":{"name":{"description":"The name of the step.","type":"string"},"onFailure":{"description":"The list of step names to execute upon failure of this step.","items":{"type":"string"},"type":"array"},"onSuccess":{"description":"The list of step names to execute upon success of this step.","items":{"type":"string"},"type":"array"},"properties":{"$ref":"#/definitions/Properties"},"type":{"description":"The type of the step.","enum":["request","elementRequest","transform","filter","script"],"type":"string"}},"required":["name","type"],"type":"object"},"StepExecution":{"properties":{"createdDate":{"type":"string","format":"date-time","description":"The date and time the execution step was created, in ISO-8601 format (e.g. 2015-09-08T21:31:42Z)."},"id":{"type":"integer","description":"The ID of the execution step."},"status":{"description":"The status of the execution step.","enum":["pending","queued","success","failed","unknown"],"type":"string"},"stepExecutionValues":{"description":"The execution step values.","items":{"$ref":"#/definitions/StepExecutionValue"},"type":"array"},"stepName":{"description":"The name of the execution step.","type":"string"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time the execution step was last updated, in ISO-8601 format (e.g. 2015-09-08T21:31:42Z)."}},"type":"object"},"StepExecutionValue":{"properties":{"id":{"type":"string","description":"The ID of the step execution value."},"key":{"type":"string","description":"The key of the step execution value."},"value":{"type":"string","description":"The value of the step execution value."}},"type":"object"},"Trigger":{"type":"object","properties":{"calendarName":{"type":"string"},"mayFireAgain":{"type":"boolean"},"nextFireTime":{"type":"integer"},"description":{"type":"string"},"startTime":{"type":"integer"},"id":{"type":"string"},"endTime":{"type":"string"},"state":{"type":"string"},"priority":{"type":"integer"}}},"UpdateFormula":{"properties":{"active":{"description":"Whether this formula is active or not.","type":"boolean"},"configuration":{"items":{"$ref":"#/definitions/Configuration"},"type":"array"},"description":{"description":"The description of what this formula does.","type":"string"},"name":{"description":"The name of the formula template (e.g. CRM --> Marketing). The name must be unique.","type":"string"},"steps":{"items":{"$ref":"#/definitions/Step"},"type":"array"},"triggers":{"items":{"$ref":"#/definitions/Trigger"},"type":"array"}},"required":["name"],"type":"object"},"PartialUpdateFormula":{"properties":{"active":{"description":"Whether this formula is active or not.","type":"boolean"},"description":{"description":"The description of what this formula does.","type":"string"},"name":{"description":"The name of the formula template (e.g. CRM --> Marketing). The name must be unique.","type":"string"}},"type":"object"},"Createjob":{"type":"object","properties":{"instanceId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"method":{"type":"string"},"body":{"$ref":"#/definitions/CreateJobBody"},"headers":{"$ref":"#/definitions/CreateJobHeaders"},"query":{"$ref":"#/definitions/CreateJobQuery"},"uri":{"type":"string"},"trigger":{"$ref":"#/definitions/CreateTrigger"}}},"CreateJobBody":{"type":"object","properties":{"name":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"}}},"CreateJobHeaders":{"type":"object","properties":{"SampleHeader":{"type":"string"}}},"CreateJobQuery":{"type":"object","properties":{"page":{"type":"integer"},"pageSize":{"type":"integer"},"where":{"type":"string"}}},"CreatedJob":{"type":"object","properties":{"schedule":{"type":"string"},"name":{"type":"string"},"id":{"type":"string"}}},"Reschedule":{"type":"object","properties":{"trigger":{"$ref":"#/definitions/CreateTrigger"}}},"JobHistory":{"type":"object","properties":{"job_class_name":{"type":"string"},"company_id":{"type":"integer"},"created_dt":{"type":"integer"},"job_group":{"type":"string"},"job_history_id":{"type":"integer"},"end_time":{"type":"integer"},"description":{"type":"string"},"external_id":{"type":"string"},"job_state":{"type":"string"},"start_time":{"type":"integer"},"account_id":{"type":"integer"},"instance_id":{"type":"integer"},"job_name":{"type":"string"},"user_id":{"type":"integer"},"updated_dt":{"type":"integer"},"job_data":{"type":"string"},"job_error_message":{"type":"string"}}},"JobHistories":{"type":"array","items":{"$ref":"#/definitions/JobHistory"}},"JobExecution":{"type":"object","properties":{"job_class_name":{"type":"string"},"start_time":{"type":"integer"},"job_name":{"type":"string"},"job_group":{"type":"string"},"job_history_id":{"type":"integer"},"end_time":{"type":"integer"},"job_data":{"type":"string"},"description":{"type":"string"},"job_error_message":{"type":"string"},"element_key":{"type":"string"},"job_state":{"type":"string"}}},"JobExecutions":{"type":"array","items":{"$ref":"#/definitions/JobExecution"}},"Job":{"type":"object","properties":{"disallowConcurrent":{"type":"boolean"},"data":{"$ref":"#/definitions/Data"},"name":{"type":"string"},"description":{"type":"string"},"id":{"type":"string"},"trigger":{"$ref":"#/definitions/Trigger"}}},"Jobs":{"type":"array","items":{"$ref":"#/definitions/Job"}},"Data":{"type":"object","properties":{"elementKey":{"type":"string"},"topic":{"type":"string"},"id":{"type":"integer"}}},"JobsPollingDisabled":{"type":"array","items":{"$ref":"#/definitions/JobsPollingDisabledObject"}},"JobsPollingDisabledObject":{"type":"object","properties":{"id":{"x-samplevalue":"MjoyOjI6OTEwOmZW50cmFsIDkxMCBldmVudCBwb2xsZXI","type":"string"},"pollingErrorDetails":{"type":"array","items":{"$ref":"#/definitions/JobsPollingDisabledPollingErrorDetails"}}}},"JobsPollingDisabledPollingErrorDetails":{"properties":{"lastPollISO8601":{"x-samplevalue":"2020-10-11T22:27:16+05:30","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","format":"date-time","type":"string"},"lastPoll":{"x-samplevalue":1602435436397,"format":"int64","type":"integer"},"elementInstanceId":{"x-samplevalue":910,"format":"int32","type":"integer"},"quartzJobName":{"x-samplevalue":"MjoyOjI6OTEwOmZW50cmFsIDkxMCBldmVudCBwb2xsZXI","type":"string"},"firstErrorStatusCode":{"x-samplevalue":0,"format":"int32","type":"integer"},"errorCount":{"x-samplevalue":404,"format":"int32","type":"integer"},"object":{"x-samplevalue":"itemCategories","type":"string"},"errorMessage":{"x-samplevalue":"{\"requestId\":\"5f8efc6fe4b03d2aa122cbcf\",\"message\":\"Element was not setup properly. This element does not return a root array for its pluralized responses, so a 'rootKey' field is needed to be set on this resource\"}","type":"string"}},"type":"object"},"audit-logs":{"properties":{"instance_id":{"description":"The id of the formula or element instance","type":"integer","example":"25077"},"account_id":{"description":"The Account Id of the account associated with the user who made of the request","type":"integer","example":"8535"},"method":{"description":"The method used in the request: GET, POST, PATCH, DELETE","type":"string","example":"POST"},"user_id":{"description":"The User Id of the user who made of the request","type":"integer","example":"3304"},"org_id":{"description":"The Organization Id of the user who made of the request","type":"integer","example":"508"},"resource_uri":{"description":"The endpoint of the request","type":"string","example":"/elements/api-v2/hubs/general/provider-events"},"id":{"type":"string","example":"AWEQO2nerdAG_hR-5hh1"},"ip_address":{"description":"Origin of the request","type":"string","example":"35.163.23.192"},"entity_id":{"description":"The id of the object acted upon in the request","type":"string","example":"AWEQO2nerdAG_hR-5hh1"},"timestamp":{"description":"Date and time of the request","format":"date-time","type":"string","example":"2018-01-26T20:58:05.000Z"},"status":{"description":"Status code of the request","type":"number","example":200}},"type":"object"},"CloudFile":{"properties":{"createdDate":{"type":"string"},"directory":{"type":"boolean"},"id":{"type":"string"},"modifiedDate":{"type":"string"},"name":{"type":"string"},"path":{"type":"string"},"size":{"format":"int32","type":"integer"},"tags":{"items":{"type":"string"},"type":"array"}},"required":["path","tags"],"type":"object"},"CloudLink":{"properties":{"cloudElementsLink":{"type":"string"},"expires":{"type":"string"},"providerLink":{"type":"string"},"providerViewLink":{"type":"string"}},"type":"object"},"CloudStorage":{"properties":{"shared":{"format":"int32","type":"integer"},"total":{"format":"int64","type":"integer"},"used":{"format":"int64","type":"integer"}},"type":"object"},"Metadata":{"properties":{"path":{"type":"string"},"tags":{"items":{"type":"string"},"type":"array"}},"type":"object"},"Address":{"properties":{"address1":{"type":"string"},"city":{"type":"string"},"country":{"type":"string"},"phone":{"type":"string"},"province":{"type":"string"},"zip":{"type":"string"}},"type":"object"},"Contact":{"description":"A contact object. With the exception of the 'id' field, the required fields indicated are those required to create a new contact. For other contact operations, the required fields will be a subset of these fields. There will be other fields returned with a Contact, which are not all described here.","properties":{"accountId":{"type":"string"},"address":{"$ref":"#/definitions/Address"},"department":{"type":"string"},"email":{"type":"string"},"firstName":{"type":"string"},"id":{"type":"string"},"lastName":{"type":"string"},"mobile":{"type":"string"},"phone":{"type":"string"},"title":{"type":"string"}},"required":["lastName"],"type":"object"},"Lead":{"description":"A lead object. With the exception of the 'id' field, the required fields indicated are those required to create a new lead. For other lead operations, the required fields will be a subset of these fields. There will be other fields returned with a Lead, which are not all described here.","properties":{"address":{"$ref":"#/definitions/Address"},"company":{"type":"string"},"description":{"type":"string"},"email":{"type":"string"},"firstName":{"type":"string"},"id":{"type":"string"},"lastName":{"type":"string"},"mobile":{"type":"string"},"phone":{"type":"string"},"source":{"type":"string"},"status":{"type":"string"},"title":{"type":"string"}},"required":["lastName","company","status"],"type":"object"},"Opportunity":{"description":"A opportunity object. With the exception of the 'id' field, the required fields indicated are those required to create a new opportunity. For other opportunity operations, the required fields will be a subset of these fields. There will be other fields returned with a Opportunity, which are not all described here.","properties":{"accountId":{"type":"string"},"amount":{"format":"double","type":"number"},"closeDate":{"type":"string"},"description":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"source":{"type":"string"},"stage":{"type":"string"},"type":{"type":"string"}},"required":["name","closeDate","stage"],"type":"object"},"Product":{"properties":{"description":{"type":"string"},"product_type":{"type":"string"},"title":{"type":"string"},"vendor":{"type":"string"}},"required":["title","product_type"],"type":"object"},"AccountTranslationList":{"properties":{"replaceAll":{"type":"boolean"},"translation":{"$ref":"#/definitions/ClassTranslation"}},"type":"object"},"AccountType":{"properties":{"value":{"type":"string"}},"type":"object"},"AvsMatchCode":{"properties":{"value":{"type":"string"}},"type":"object"},"CategoryList":{"properties":{"category":{"$ref":"#/definitions/RecordRef"}},"type":"object"},"ClassTranslation":{"properties":{"language":{"type":"string"},"locale":{"type":"string"},"name":{"type":"string"}},"type":"object"},"ConsolidatedRate":{"properties":{"value":{"type":"string"}},"type":"object"},"ContactAccessRoles":{"properties":{"contact":{"$ref":"#/definitions/RecordRef"},"email":{"type":"string"},"giveAccess":{"type":"boolean"},"password":{"type":"string"},"password2":{"type":"string"},"role":{"$ref":"#/definitions/RecordRef"},"sendEmail":{"type":"boolean"}},"type":"object"},"ContactAccessRolesList":{"properties":{"contactRoles":{"$ref":"#/definitions/ContactAccessRoles"},"replaceAll":{"type":"boolean"}},"type":"object"},"ContactAddressbook":{"properties":{"addressbookAddress":{"$ref":"#/definitions/Address"},"defaultBilling":{"type":"boolean"},"defaultShipping":{"type":"boolean"},"internalId":{"type":"string"},"label":{"type":"string"}},"type":"object"},"ContactAddressbookList":{"properties":{"addressbook":{"$ref":"#/definitions/ContactAddressbook"},"replaceAll":{"type":"boolean"}},"type":"object"},"Country":{"properties":{"value":{"type":"string"}},"type":"object"},"CurrencySymbolPlacement":{"properties":{"value":{"type":"string"}},"type":"object"},"CustomFieldList":{"properties":{"customField":{"$ref":"#/definitions/CustomFieldRef"}},"type":"object"},"CustomFieldRef":{"properties":{"internalId":{"type":"string"},"scriptId":{"type":"string"}},"type":"object"},"CustomerAddressbook":{"properties":{"addressbookAddress":{"$ref":"#/definitions/Address"},"defaultBilling":{"type":"boolean"},"defaultShipping":{"type":"boolean"},"internalId":{"type":"string"},"isResidential":{"type":"boolean"},"label":{"type":"string"}},"type":"object"},"CustomerAddressbookList":{"properties":{"addressbook":{"$ref":"#/definitions/CustomerAddressbook"},"replaceAll":{"type":"boolean"}},"type":"object"},"CustomerCreditCards":{"properties":{"cardState":{"$ref":"#/definitions/RecordRef"},"ccDefault":{"type":"boolean"},"ccExpireDate":{"format":"date","type":"string"},"ccMemo":{"type":"string"},"ccName":{"type":"string"},"ccNumber":{"type":"string"},"debitcardIssueNo":{"type":"string"},"internalId":{"type":"string"},"paymentMethod":{"$ref":"#/definitions/RecordRef"},"stateFrom":{"format":"date","type":"string"},"validfrom":{"format":"date","type":"string"}},"type":"object"},"CustomerCreditCardsList":{"properties":{"creditCards":{"$ref":"#/definitions/CustomerCreditCards"},"replaceAll":{"type":"boolean"}},"type":"object"},"CustomerCreditHoldOverride":{"properties":{"value":{"type":"string"}},"type":"object"},"CustomerCurrency":{"properties":{"balance":{"type":"number"},"consolBalance":{"type":"number"},"consolDepositBalance":{"type":"number"},"consolOverdueBalance":{"type":"number"},"consolUnbilledOrders":{"type":"number"},"currency":{"$ref":"#/definitions/RecordRef"},"depositBalance":{"type":"number"},"displaySymbol":{"type":"string"},"overdueBalance":{"type":"number"},"overrideCurrencyFormat":{"type":"boolean"},"symbolPlacement":{"$ref":"#/definitions/CurrencySymbolPlacement"},"unbilledOrders":{"type":"number"}},"type":"object"},"CustomerCurrencyList":{"properties":{"currency":{"$ref":"#/definitions/CustomerCurrency"},"replaceAll":{"type":"boolean"}},"type":"object"},"CustomerDownload":{"properties":{"expiration":{"format":"date","type":"string"},"file":{"$ref":"#/definitions/RecordRef"},"licenseCode":{"type":"string"},"remainingDownloads":{"type":"number"}},"type":"object"},"CustomerDownloadList":{"properties":{"download":{"$ref":"#/definitions/CustomerDownload"},"replaceAll":{"type":"boolean"}},"type":"object"},"CustomerGroupPricing":{"properties":{"group":{"$ref":"#/definitions/RecordRef"},"level":{"$ref":"#/definitions/RecordRef"}},"type":"object"},"CustomerGroupPricingList":{"properties":{"groupPricing":{"$ref":"#/definitions/CustomerGroupPricing"},"replaceAll":{"type":"boolean"}},"type":"object"},"CustomerItemPricing":{"properties":{"currency":{"$ref":"#/definitions/RecordRef"},"item":{"$ref":"#/definitions/RecordRef"},"level":{"$ref":"#/definitions/RecordRef"},"price":{"type":"number"}},"type":"object"},"CustomerItemPricingList":{"properties":{"itemPricing":{"$ref":"#/definitions/CustomerItemPricing"},"replaceAll":{"type":"boolean"}},"type":"object"},"CustomerMonthlyClosing":{"properties":{"value":{"type":"string"}},"type":"object"},"CustomerNegativeNumberFormat":{"properties":{"value":{"type":"string"}},"type":"object"},"CustomerNumberFormat":{"properties":{"value":{"type":"string"}},"type":"object"},"CustomerPartnersList":{"properties":{"partners":{"$ref":"#/definitions/Partners"},"replaceAll":{"type":"boolean"}},"type":"object"},"CustomerPaymentApply":{"properties":{"amount":{"type":"number"},"apply":{"type":"boolean"},"applyDate":{"format":"date","type":"string"},"currency":{"type":"string"},"disc":{"type":"number"},"discAmt":{"type":"number"},"discDate":{"format":"date","type":"string"},"doc":{"type":"number"},"due":{"type":"number"},"job":{"type":"string"},"line":{"type":"number"},"refNum":{"type":"string"},"total":{"type":"number"},"type":{"type":"string"}},"type":"object"},"CustomerPaymentApplyList":{"properties":{"apply":{"$ref":"#/definitions/CustomerPaymentApply"},"replaceAll":{"type":"boolean"}},"type":"object"},"CustomerPaymentCredit":{"properties":{"amount":{"type":"number"},"appliedTo":{"type":"string"},"apply":{"type":"boolean"},"creditDate":{"format":"date","type":"string"},"currency":{"type":"string"},"doc":{"type":"number"},"due":{"type":"number"},"line":{"type":"number"},"refNum":{"type":"string"},"total":{"type":"number"},"type":{"type":"string"}},"type":"object"},"CustomerPaymentCreditList":{"properties":{"credit":{"$ref":"#/definitions/CustomerPaymentCredit"},"replaceAll":{"type":"boolean"}},"type":"object"},"CustomerPaymentDeposit":{"properties":{"amount":{"type":"number"},"apply":{"type":"boolean"},"currency":{"type":"string"},"depositDate":{"format":"date","type":"string"},"doc":{"type":"number"},"line":{"type":"number"},"refNum":{"type":"string"},"remaining":{"type":"number"},"total":{"type":"number"}},"type":"object"},"CustomerPaymentDepositList":{"properties":{"deposit":{"$ref":"#/definitions/CustomerPaymentDeposit"},"replaceAll":{"type":"boolean"}},"type":"object"},"CustomerSalesTeam":{"properties":{"contribution":{"type":"number"},"employee":{"$ref":"#/definitions/RecordRef"},"isPrimary":{"type":"boolean"},"salesRole":{"$ref":"#/definitions/RecordRef"}},"type":"object"},"CustomerSalesTeamList":{"properties":{"replaceAll":{"type":"boolean"},"salesTeam":{"$ref":"#/definitions/CustomerSalesTeam"}},"type":"object"},"CustomerStage":{"properties":{"value":{"type":"string"}},"type":"object"},"Duration":{"properties":{"timeSpan":{"format":"double","type":"number"},"unit":{"$ref":"#/definitions/DurationUnit"}},"type":"object"},"DurationUnit":{"properties":{"value":{"type":"string"}},"type":"object"},"EmailPreference":{"properties":{"value":{"type":"string"}},"type":"object"},"Employee":{"description":"A employee object. With the exception of the 'id' field, the required fields indicated are those required to create a new employee. For other employee operations, the required fields will be a subset of these fields. There will be other fields returned with a Employee, which are not all described here.","properties":{"active":{"type":"string"},"createdDate":{"format":"date-time","type":"string"},"firstName":{"type":"string"},"hireDate":{"format":"date-time","type":"string"},"id":{"type":"string"},"lastName":{"type":"string"},"middleName":{"type":"string"},"nationalId":{"type":"string"},"primaryAddress":{"$ref":"#/definitions/Address"},"primaryPhone":{"type":"string"},"title":{"type":"string"},"updatedDate":{"format":"date-time","type":"string"},"version":{"type":"string"}},"required":["firstName","lastName"],"type":"object"},"EmployeeAccruedTime":{"properties":{"accrualMethod":{"$ref":"#/definitions/EmployeeAccruedTimeAccrualMethod"},"accrualRate":{"type":"number"},"accruedHours":{"type":"number"},"effectiveDate":{"format":"date","type":"string"},"expirationDate":{"format":"date","type":"string"},"inactive":{"type":"boolean"},"maximumAccruedHours":{"type":"number"},"monetaryRate":{"type":"number"},"payrollItem":{"$ref":"#/definitions/RecordRef"},"resetAccruedHoursAtYearEnd":{"type":"boolean"}},"type":"object"},"EmployeeAccruedTimeAccrualMethod":{"properties":{"value":{"type":"string"}},"type":"object"},"EmployeeAccruedTimeList":{"properties":{"employeeAccruedTime":{"$ref":"#/definitions/EmployeeAccruedTime"},"replaceAll":{"type":"boolean"}},"type":"object"},"EmployeeAddressbook":{"properties":{"addressbookAddress":{"$ref":"#/definitions/Address"},"defaultBilling":{"type":"boolean"},"defaultShipping":{"type":"boolean"},"internalId":{"type":"string"},"label":{"type":"string"}},"type":"object"},"EmployeeAddressbookList":{"properties":{"addressbook":{"$ref":"#/definitions/EmployeeAddressbook"},"replaceAll":{"type":"boolean"}},"type":"object"},"EmployeeCommissionPaymentPreference":{"properties":{"value":{"type":"string"}},"type":"object"},"EmployeeCompanyContribution":{"properties":{"effectiveDate":{"format":"date","type":"string"},"expirationDate":{"format":"date","type":"string"},"inactive":{"type":"boolean"},"limit":{"type":"number"},"payrollItem":{"$ref":"#/definitions/RecordRef"},"rate":{"type":"string"}},"type":"object"},"EmployeeCompanyContributionList":{"properties":{"employeeCompanyContribution":{"$ref":"#/definitions/EmployeeCompanyContribution"},"replaceAll":{"type":"boolean"}},"type":"object"},"EmployeeDeduction":{"properties":{"effectiveDate":{"format":"date","type":"string"},"expirationDate":{"format":"date","type":"string"},"inactive":{"type":"boolean"},"limit":{"type":"number"},"payrollItem":{"$ref":"#/definitions/RecordRef"},"rate":{"type":"string"}},"type":"object"},"EmployeeDeductionList":{"properties":{"employeeDeduction":{"$ref":"#/definitions/EmployeeDeduction"},"replaceAll":{"type":"boolean"}},"type":"object"},"EmployeeDirectDeposit":{"properties":{"accountPrenoted":{"type":"boolean"},"accountStatus":{"$ref":"#/definitions/EmployeeDirectDepositAccountStatus"},"amount":{"type":"number"},"bankAccountNumber":{"type":"string"},"bankId":{"type":"string"},"bankName":{"type":"string"},"bankNumber":{"type":"string"},"bankRoutingNumber":{"type":"string"},"id":{"type":"number"},"inactive":{"type":"boolean"},"netAccount":{"type":"boolean"},"savingsAccount":{"type":"boolean"}},"type":"object"},"EmployeeDirectDepositAccountStatus":{"properties":{"value":{"type":"string"}},"type":"object"},"EmployeeDirectDepositList":{"properties":{"employeeDirectDeposit":{"$ref":"#/definitions/EmployeeDirectDeposit"},"replaceAll":{"type":"boolean"}},"type":"object"},"EmployeeEarning":{"properties":{"defaultEarning":{"type":"boolean"},"defaultHours":{"type":"number"},"effectiveDate":{"format":"date","type":"string"},"expirationDate":{"format":"date","type":"string"},"inactive":{"type":"boolean"},"payRate":{"type":"string"},"payrollItem":{"$ref":"#/definitions/RecordRef"},"primaryEarning":{"type":"boolean"}},"type":"object"},"EmployeeEarningList":{"properties":{"employeeEarning":{"$ref":"#/definitions/EmployeeEarning"},"replaceAll":{"type":"boolean"}},"type":"object"},"EmployeeEmergencyContact":{"properties":{"address":{"type":"string"},"contact":{"type":"string"},"id":{"type":"number"},"phone":{"type":"string"},"relationship":{"type":"string"}},"type":"object"},"EmployeeEmergencyContactList":{"properties":{"employeeEmergencyContact":{"$ref":"#/definitions/EmployeeEmergencyContact"},"replaceAll":{"type":"boolean"}},"type":"object"},"EmployeeHrEducation":{"properties":{"degree":{"type":"string"},"degreeDate":{"format":"date","type":"string"},"education":{"$ref":"#/definitions/RecordRef"}},"type":"object"},"EmployeeHrEducationList":{"properties":{"employeeHrEducation":{"$ref":"#/definitions/EmployeeHrEducation"},"replaceAll":{"type":"boolean"}},"type":"object"},"EmployeePayFrequency":{"properties":{"value":{"type":"string"}},"type":"object"},"EmployeeRoles":{"properties":{"selectedRole":{"$ref":"#/definitions/RecordRef"}},"type":"object"},"EmployeeRolesList":{"properties":{"replaceAll":{"type":"boolean"},"roles":{"$ref":"#/definitions/EmployeeRoles"}},"type":"object"},"EmployeeSubscriptions":{"properties":{"lastModifiedDate":{"format":"date","type":"string"},"subscribed":{"type":"string"},"subscription":{"type":"string"}},"type":"object"},"EmployeeSubscriptionsList":{"properties":{"replaceAll":{"type":"boolean"},"subscriptions":{"$ref":"#/definitions/EmployeeSubscriptions"}},"type":"object"},"EmployeeUseTimeData":{"properties":{"value":{"type":"string"}},"type":"object"},"Gender":{"properties":{"value":{"type":"string"}},"type":"object"},"GiftCertRedemption":{"properties":{"authCode":{"$ref":"#/definitions/RecordRef"},"authCodeAmtRemaining":{"type":"number"},"authCodeApplied":{"type":"number"},"giftCertAvailable":{"type":"number"}},"type":"object"},"GiftCertRedemptionList":{"properties":{"giftCertRedemption":{"$ref":"#/definitions/GiftCertRedemption"},"replaceAll":{"type":"boolean"}},"type":"object"},"GlobalSubscriptionStatus":{"properties":{"value":{"type":"string"}},"type":"object"},"HazmatPackingGroup":{"properties":{"value":{"type":"string"}},"type":"object"},"IntercoStatus":{"properties":{"value":{"type":"string"}},"type":"object"},"InventoryAssignment":{"properties":{"binNumber":{"$ref":"#/definitions/RecordRef"},"expirationDate":{"format":"date","type":"string"},"internalId":{"type":"string"},"issueInventoryNumber":{"$ref":"#/definitions/RecordRef"},"quantity":{"type":"number"},"quantityAvailable":{"type":"boolean"},"receiptInventoryNumber":{"type":"string"},"toBinNumber":{"$ref":"#/definitions/RecordRef"}},"type":"object"},"InventoryAssignmentList":{"properties":{"inventoryAssignment":{"$ref":"#/definitions/InventoryAssignment"},"replaceAll":{"type":"boolean"}},"type":"object"},"InventoryDetail":{"properties":{"customForm":{"$ref":"#/definitions/RecordRef"},"inventoryAssignmentList":{"$ref":"#/definitions/InventoryAssignmentList"},"nullFieldList":{"$ref":"#/definitions/NullField"}},"type":"object"},"InventoryItemBinNumber":{"properties":{"binNumber":{"$ref":"#/definitions/RecordRef"},"location":{"type":"string"},"onHand":{"type":"string"},"onHandAvail":{"type":"string"},"preferredBin":{"type":"boolean"}},"type":"object"},"InventoryItemBinNumberList":{"properties":{"binNumber":{"$ref":"#/definitions/InventoryItemBinNumber"},"replaceAll":{"type":"boolean"}},"type":"object"},"InventoryItemFraudRisk":{"properties":{"value":{"type":"string"}},"type":"object"},"InventoryItemLocations":{"properties":{"alternateDemandSourceItem":{"$ref":"#/definitions/RecordRef"},"averageCostMli":{"type":"number"},"backwardConsumptionDays":{"type":"number"},"buildTime":{"type":"number"},"cost":{"type":"number"},"costingLotSize":{"type":"number"},"defaultReturnCost":{"type":"number"},"demandSource":{"$ref":"#/definitions/RecordRef"},"demandTimeFence":{"type":"number"},"fixedLotSize":{"type":"number"},"forwardConsumptionDays":{"type":"number"},"inventoryCostTemplate":{"$ref":"#/definitions/RecordRef"},"invtClassification":{"$ref":"#/definitions/ItemInvtClassification"},"invtCountInterval":{"type":"number"},"isWip":{"type":"boolean"},"lastInvtCountDate":{"format":"date","type":"string"},"lastPurchasePriceMli":{"type":"number"},"leadTime":{"type":"number"},"location":{"type":"string"},"locationId":{"$ref":"#/definitions/RecordRef"},"nextInvtCountDate":{"format":"date","type":"string"},"onHandValueMli":{"type":"number"},"periodicLotSizeDays":{"type":"number"},"periodicLotSizeType":{"$ref":"#/definitions/PeriodicLotSizeType"},"preferredStockLevel":{"type":"number"},"quantityAvailable":{"type":"number"},"quantityBackOrdered":{"type":"number"},"quantityCommitted":{"type":"number"},"quantityOnHand":{"type":"number"},"quantityOnOrder":{"type":"number"},"reorderPoint":{"type":"number"},"rescheduleInDays":{"type":"number"},"rescheduleOutDays":{"type":"number"},"safetyStockLevel":{"type":"number"},"supplyLotSizingMethod":{"$ref":"#/definitions/RecordRef"},"supplyReplenishmentMethod":{"$ref":"#/definitions/RecordRef"},"supplyTimeFence":{"type":"number"},"supplyType":{"$ref":"#/definitions/RecordRef"}},"type":"object"},"InventoryItemLocationsList":{"properties":{"locations":{"$ref":"#/definitions/InventoryItemLocations"},"replaceAll":{"type":"boolean"}},"type":"object"},"InvoiceExpCost":{"properties":{"_class":{"type":"string"},"amount":{"type":"number"},"apply":{"type":"boolean"},"billedDate":{"format":"date","type":"string"},"categoryDisp":{"type":"string"},"department":{"type":"string"},"doc":{"type":"number"},"employeeDisp":{"type":"string"},"grossAmt":{"type":"number"},"jobDisp":{"type":"string"},"line":{"type":"number"},"location":{"type":"string"},"memo":{"type":"string"},"originalAmount":{"type":"number"},"revRecEndDate":{"format":"date","type":"string"},"revRecSchedule":{"$ref":"#/definitions/RecordRef"},"revRecStartDate":{"format":"date","type":"string"},"tax1Amt":{"type":"number"},"taxCode":{"$ref":"#/definitions/RecordRef"},"taxRate1":{"type":"number"},"taxRate2":{"type":"number"},"taxableDisp":{"type":"string"}},"type":"object"},"InvoiceExpCostList":{"properties":{"expCost":{"$ref":"#/definitions/InvoiceExpCost"},"replaceAll":{"type":"boolean"}},"type":"object"},"InvoiceItem":{"properties":{"_class":{"$ref":"#/definitions/RecordRef"},"amount":{"type":"number"},"amountOrdered":{"type":"number"},"binNumbers":{"type":"string"},"catchUpPeriod":{"$ref":"#/definitions/RecordRef"},"chargeType":{"$ref":"#/definitions/RecordRef"},"chargesList":{"$ref":"#/definitions/RecordRefList"},"costEstimate":{"type":"number"},"costEstimateType":{"$ref":"#/definitions/ItemCostEstimateType"},"currentPercent":{"type":"number"},"customFieldList":{"$ref":"#/definitions/CustomFieldList"},"deferRevRec":{"type":"boolean"},"department":{"$ref":"#/definitions/RecordRef"},"description":{"type":"string"},"excludeFromRateRequest":{"type":"boolean"},"giftCertFrom":{"type":"string"},"giftCertMessage":{"type":"string"},"giftCertNumber":{"type":"string"},"giftCertRecipientEmail":{"type":"string"},"giftCertRecipientName":{"type":"string"},"grossAmt":{"type":"number"},"inventoryDetail":{"$ref":"#/definitions/InventoryDetail"},"isTaxable":{"type":"boolean"},"item":{"$ref":"#/definitions/RecordRef"},"itemIsFulfilled":{"type":"boolean"},"job":{"$ref":"#/definitions/RecordRef"},"licenseCode":{"type":"string"},"line":{"type":"number"},"location":{"$ref":"#/definitions/RecordRef"},"options":{"$ref":"#/definitions/CustomFieldList"},"orderLine":{"type":"number"},"percentComplete":{"type":"number"},"price":{"$ref":"#/definitions/RecordRef"},"quantity":{"type":"number"},"quantityAvailable":{"type":"number"},"quantityFulfilled":{"type":"number"},"quantityOnHand":{"type":"number"},"quantityOrdered":{"type":"number"},"quantityRemaining":{"type":"number"},"rate":{"type":"string"},"revRecEndDate":{"format":"date","type":"string"},"revRecSchedule":{"$ref":"#/definitions/RecordRef"},"revRecStartDate":{"format":"date","type":"string"},"serialNumbers":{"type":"string"},"shipAddress":{"$ref":"#/definitions/RecordRef"},"shipGroup":{"type":"number"},"shipMethod":{"$ref":"#/definitions/RecordRef"},"tax1Amt":{"type":"number"},"taxCode":{"$ref":"#/definitions/RecordRef"},"taxRate1":{"type":"number"},"taxRate2":{"type":"number"},"units":{"$ref":"#/definitions/RecordRef"},"vsoeAllocation":{"type":"number"},"vsoeAmount":{"type":"number"},"vsoeDeferral":{"$ref":"#/definitions/VsoeDeferral"},"vsoeDelivered":{"type":"boolean"},"vsoeIsEstimate":{"type":"boolean"},"vsoePermitDiscount":{"$ref":"#/definitions/VsoePermitDiscount"},"vsoePrice":{"type":"number"},"vsoeSopGroup":{"$ref":"#/definitions/VsoeSopGroup"}},"type":"object"},"InvoiceItemCost":{"properties":{"_class":{"type":"string"},"amount":{"type":"number"},"apply":{"type":"boolean"},"billedDate":{"format":"date","type":"string"},"cost":{"type":"number"},"department":{"type":"string"},"doc":{"type":"number"},"grossAmt":{"type":"number"},"itemCostCount":{"type":"string"},"itemDisp":{"type":"string"},"jobDisp":{"type":"string"},"line":{"type":"number"},"location":{"type":"string"},"memo":{"type":"string"},"options":{"$ref":"#/definitions/CustomFieldList"},"quantity":{"type":"string"},"revRecEndDate":{"format":"date","type":"string"},"revRecSchedule":{"$ref":"#/definitions/RecordRef"},"revRecStartDate":{"format":"date","type":"string"},"serialNumbers":{"type":"string"},"tax1Amt":{"type":"number"},"taxCode":{"$ref":"#/definitions/RecordRef"},"taxRate1":{"type":"number"},"taxRate2":{"type":"number"},"unitDisp":{"type":"string"}},"type":"object"},"InvoiceItemCostList":{"properties":{"itemCost":{"$ref":"#/definitions/InvoiceItemCost"},"replaceAll":{"type":"boolean"}},"type":"object"},"InvoiceItemList":{"properties":{"item":{"$ref":"#/definitions/InvoiceItem"},"replaceAll":{"type":"boolean"}},"type":"object"},"InvoicePartnersList":{"properties":{"partners":{"$ref":"#/definitions/Partners"},"replaceAll":{"type":"boolean"}},"type":"object"},"InvoiceSalesTeam":{"properties":{"contribution":{"type":"number"},"employee":{"$ref":"#/definitions/RecordRef"},"isPrimary":{"type":"boolean"},"salesRole":{"$ref":"#/definitions/RecordRef"}},"type":"object"},"InvoiceSalesTeamList":{"properties":{"replaceAll":{"type":"boolean"},"salesTeam":{"$ref":"#/definitions/InvoiceSalesTeam"}},"type":"object"},"InvoiceShipGroupList":{"properties":{"replaceAll":{"type":"boolean"},"shipGroup":{"$ref":"#/definitions/TransactionShipGroup"}},"type":"object"},"InvoiceTime":{"properties":{"_class":{"type":"string"},"amount":{"type":"number"},"apply":{"type":"boolean"},"billedDate":{"format":"date","type":"string"},"department":{"type":"string"},"doc":{"type":"number"},"employeeDisp":{"type":"string"},"grossAmt":{"type":"number"},"itemDisp":{"type":"string"},"jobDisp":{"type":"string"},"line":{"type":"number"},"location":{"type":"string"},"memo":{"type":"string"},"quantity":{"type":"string"},"rate":{"type":"number"},"revRecEndDate":{"format":"date","type":"string"},"revRecSchedule":{"$ref":"#/definitions/RecordRef"},"revRecStartDate":{"format":"date","type":"string"},"tax1Amt":{"type":"number"},"taxCode":{"$ref":"#/definitions/RecordRef"},"taxRate1":{"type":"number"},"taxRate2":{"type":"number"},"unitDisp":{"type":"string"}},"type":"object"},"InvoiceTimeList":{"properties":{"replaceAll":{"type":"boolean"},"time":{"$ref":"#/definitions/InvoiceTime"}},"type":"object"},"ItemAccountingBookDetail":{"properties":{"accountingBook":{"$ref":"#/definitions/RecordRef"},"amortizationTemplate":{"$ref":"#/definitions/RecordRef"},"revRecSchedule":{"$ref":"#/definitions/RecordRef"},"sameAsPrimaryAmortization":{"type":"boolean"},"sameAsPrimaryRevRec":{"type":"boolean"}},"type":"object"},"ItemAccountingBookDetailList":{"properties":{"itemAccountingBookDetail":{"$ref":"#/definitions/ItemAccountingBookDetail"},"replaceAll":{"type":"boolean"}},"type":"object"},"ItemCarrier":{"properties":{"value":{"type":"string"}},"type":"object"},"ItemCostEstimateType":{"properties":{"value":{"type":"string"}},"type":"object"},"ItemCostingMethod":{"properties":{"value":{"type":"string"}},"type":"object"},"ItemInvtClassification":{"properties":{"value":{"type":"string"}},"type":"object"},"ItemMatrixType":{"properties":{"value":{"type":"string"}},"type":"object"},"ItemOptionsList":{"properties":{"itemOptions":{"$ref":"#/definitions/RecordRef"}},"type":"object"},"ItemOutOfStockBehavior":{"properties":{"value":{"type":"string"}},"type":"object"},"ItemOverallQuantityPricingType":{"properties":{"value":{"type":"string"}},"type":"object"},"ItemPreferenceCriterion":{"properties":{"value":{"type":"string"}},"type":"object"},"ItemProductFeed":{"properties":{"value":{"type":"string"}},"type":"object"},"ItemSubType":{"properties":{"value":{"type":"string"}},"type":"object"},"ItemType":{"properties":{"value":{"type":"string"}},"type":"object"},"ItemVendor":{"properties":{"preferredVendor":{"type":"boolean"},"purchasePrice":{"type":"number"},"schedule":{"$ref":"#/definitions/RecordRef"},"subsidiary":{"type":"string"},"vendor":{"$ref":"#/definitions/RecordRef"},"vendorCode":{"type":"string"},"vendorCurrency":{"$ref":"#/definitions/RecordRef"},"vendorCurrencyName":{"type":"string"}},"type":"object"},"ItemVendorList":{"properties":{"itemVendor":{"$ref":"#/definitions/ItemVendor"},"replaceAll":{"type":"boolean"}},"type":"object"},"ItemWeightUnit":{"properties":{"value":{"type":"string"}},"type":"object"},"JournalEntryLine":{"properties":{"amount":{"format":"float","type":"number"},"description":{"type":"string"},"detailType":{"type":"boolean"},"id":{"type":"string"},"journalEntryLineDetail":{"$ref":"#/definitions/JournalEntryLineDetail"}},"type":"object"},"JournalEntryLineList":{"properties":{"line":{"$ref":"#/definitions/JournalEntryLine"},"replaceAll":{"type":"boolean"}},"type":"object"},"Language":{"properties":{"value":{"type":"string"}},"type":"object"},"ListOrRecordRef":{"properties":{"externalId":{"type":"string"},"internalId":{"type":"string"},"name":{"type":"string"},"typeId":{"type":"string"}},"type":"object"},"MatrixOptionList":{"properties":{"matrixOption":{"$ref":"#/definitions/SelectCustomFieldRef"}},"type":"object"},"NullField":{"properties":{"name":{"type":"string"}},"type":"object"},"OpportunityCompetitors":{"properties":{"competitor":{"$ref":"#/definitions/RecordRef"},"notes":{"type":"string"},"strategy":{"type":"string"},"url":{"type":"string"},"winner":{"type":"boolean"}},"type":"object"},"OpportunityCompetitorsList":{"properties":{"competitors":{"$ref":"#/definitions/OpportunityCompetitors"},"replaceAll":{"type":"boolean"}},"type":"object"},"OpportunityItem":{"properties":{"_class":{"$ref":"#/definitions/RecordRef"},"altSalesAmt":{"type":"number"},"amount":{"type":"number"},"costEstimate":{"type":"number"},"costEstimateType":{"$ref":"#/definitions/ItemCostEstimateType"},"customFieldList":{"$ref":"#/definitions/CustomFieldList"},"department":{"$ref":"#/definitions/RecordRef"},"description":{"type":"string"},"expectedShipDate":{"format":"date","type":"string"},"fromJob":{"type":"boolean"},"grossAmt":{"type":"number"},"isEstimate":{"type":"boolean"},"item":{"$ref":"#/definitions/RecordRef"},"job":{"$ref":"#/definitions/RecordRef"},"line":{"type":"number"},"location":{"$ref":"#/definitions/RecordRef"},"options":{"$ref":"#/definitions/CustomFieldList"},"price":{"$ref":"#/definitions/RecordRef"},"quantity":{"type":"number"},"quantityAvailable":{"type":"number"},"quantityOnHand":{"type":"number"},"rate":{"type":"string"},"revRecTermInMonths":{"type":"number"},"tax1Amt":{"type":"number"},"taxCode":{"$ref":"#/definitions/RecordRef"},"taxRate1":{"type":"number"},"taxRate2":{"type":"number"},"units":{"$ref":"#/definitions/RecordRef"}},"type":"object"},"OpportunityItemList":{"properties":{"item":{"$ref":"#/definitions/OpportunityItem"},"replaceAll":{"type":"boolean"}},"type":"object"},"OpportunityPartnersList":{"properties":{"partners":{"$ref":"#/definitions/Partners"},"replaceAll":{"type":"boolean"}},"type":"object"},"OpportunitySalesTeam":{"properties":{"contribution":{"type":"number"},"employee":{"$ref":"#/definitions/RecordRef"},"isPrimary":{"type":"boolean"},"salesRole":{"$ref":"#/definitions/RecordRef"}},"type":"object"},"OpportunitySalesTeamList":{"properties":{"replaceAll":{"type":"boolean"},"salesTeam":{"$ref":"#/definitions/OpportunitySalesTeam"}},"type":"object"},"Partners":{"properties":{"contribution":{"type":"number"},"isPrimary":{"type":"boolean"},"partner":{"$ref":"#/definitions/RecordRef"},"partnerRole":{"$ref":"#/definitions/RecordRef"}},"type":"object"},"PaymentMethodVisuals":{"properties":{"flags":{"type":"string"},"location":{"type":"string"}},"type":"object"},"PaymentMethodVisualsList":{"properties":{"paymentMethodVisuals":{"$ref":"#/definitions/PaymentMethodVisuals"},"replaceAll":{"type":"boolean"}},"type":"object"},"PeriodicLotSizeType":{"properties":{"value":{"type":"string"}},"type":"object"},"PresentationItem":{"properties":{"basePrice":{"type":"number"},"description":{"type":"string"},"item":{"$ref":"#/definitions/RecordRef"},"itemType":{"$ref":"#/definitions/PresentationItemType"},"onlinePrice":{"type":"number"}},"type":"object"},"PresentationItemList":{"properties":{"presentationItem":{"$ref":"#/definitions/PresentationItem"},"replaceAll":{"type":"boolean"}},"type":"object"},"PresentationItemType":{"properties":{"value":{"type":"string"}},"type":"object"},"Price":{"properties":{"quantity":{"type":"number"},"value":{"type":"number"}},"type":"object"},"PriceList":{"properties":{"price":{"$ref":"#/definitions/Price"}},"type":"object"},"Pricing":{"properties":{"currency":{"$ref":"#/definitions/RecordRef"},"discount":{"type":"number"},"priceLevel":{"$ref":"#/definitions/RecordRef"},"priceList":{"$ref":"#/definitions/PriceList"}},"type":"object"},"PricingMatrix":{"properties":{"pricing":{"$ref":"#/definitions/Pricing"},"replaceAll":{"type":"boolean"}},"type":"object"},"ProductFeedList":{"properties":{"productFeed":{"$ref":"#/definitions/ItemProductFeed"}},"type":"object"},"PurchaseOrderExpense":{"properties":{"_class":{"$ref":"#/definitions/RecordRef"},"account":{"$ref":"#/definitions/RecordRef"},"amount":{"type":"number"},"category":{"$ref":"#/definitions/RecordRef"},"createdFrom":{"$ref":"#/definitions/RecordRef"},"customFieldList":{"$ref":"#/definitions/CustomFieldList"},"customer":{"$ref":"#/definitions/RecordRef"},"department":{"$ref":"#/definitions/RecordRef"},"grossAmt":{"type":"number"},"isBillable":{"type":"boolean"},"isClosed":{"type":"boolean"},"line":{"type":"number"},"linkedOrderList":{"$ref":"#/definitions/RecordRefList"},"location":{"$ref":"#/definitions/RecordRef"},"memo":{"type":"string"},"tax1Amt":{"type":"number"},"taxCode":{"$ref":"#/definitions/RecordRef"},"taxRate1":{"type":"number"},"taxRate2":{"type":"number"}},"type":"object"},"PurchaseOrderExpenseList":{"properties":{"expense":{"$ref":"#/definitions/PurchaseOrderExpense"},"replaceAll":{"type":"boolean"}},"type":"object"},"PurchaseOrderItem":{"properties":{"_class":{"$ref":"#/definitions/RecordRef"},"amount":{"type":"number"},"billVarianceStatus":{"$ref":"#/definitions/TransactionBillVarianceStatus"},"createdFrom":{"$ref":"#/definitions/RecordRef"},"customFieldList":{"$ref":"#/definitions/CustomFieldList"},"customer":{"$ref":"#/definitions/RecordRef"},"department":{"$ref":"#/definitions/RecordRef"},"description":{"type":"string"},"expectedReceiptDate":{"format":"date","type":"string"},"grossAmt":{"type":"number"},"inventoryDetail":{"$ref":"#/definitions/InventoryDetail"},"isBillable":{"type":"boolean"},"isClosed":{"type":"boolean"},"item":{"$ref":"#/definitions/RecordRef"},"landedCostCategory":{"$ref":"#/definitions/RecordRef"},"line":{"type":"number"},"linkedOrderList":{"$ref":"#/definitions/RecordRefList"},"location":{"$ref":"#/definitions/RecordRef"},"matchBillToReceipt":{"type":"boolean"},"options":{"$ref":"#/definitions/CustomFieldList"},"purchaseContract":{"$ref":"#/definitions/RecordRef"},"quantity":{"type":"number"},"quantityAvailable":{"type":"number"},"quantityBilled":{"type":"number"},"quantityOnHand":{"type":"number"},"quantityReceived":{"type":"number"},"rate":{"type":"string"},"serialNumbers":{"type":"string"},"tax1Amt":{"type":"number"},"taxCode":{"$ref":"#/definitions/RecordRef"},"taxRate1":{"type":"number"},"taxRate2":{"type":"number"},"units":{"$ref":"#/definitions/RecordRef"},"vendorName":{"type":"string"}},"type":"object"},"PurchaseOrderItemList":{"properties":{"item":{"$ref":"#/definitions/PurchaseOrderItem"},"replaceAll":{"type":"boolean"}},"type":"object"},"PurchaseOrderOrderStatus":{"properties":{"value":{"type":"string"}},"type":"object"},"RecordRef":{"properties":{"externalId":{"type":"string"},"internalId":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/definitions/RecordType"}},"type":"object"},"RecordRefList":{"properties":{"recordRef":{"$ref":"#/definitions/RecordRef"}},"type":"object"},"RecordType":{"properties":{"value":{"type":"string"}},"type":"object"},"RevenueStatus":{"properties":{"value":{"type":"string"}},"type":"object"},"ScheduleBCode":{"properties":{"value":{"type":"string"}},"type":"object"},"SelectCustomFieldRef":{"properties":{"internalId":{"type":"string"},"scriptId":{"type":"string"},"value":{"$ref":"#/definitions/ListOrRecordRef"}},"type":"object"},"SiteCategory":{"properties":{"category":{"$ref":"#/definitions/RecordRef"},"categoryDescription":{"type":"string"},"isDefault":{"type":"boolean"},"website":{"$ref":"#/definitions/RecordRef"}},"type":"object"},"SiteCategoryList":{"properties":{"replaceAll":{"type":"boolean"},"siteCategory":{"$ref":"#/definitions/SiteCategory"}},"type":"object"},"SitemapPriority":{"properties":{"value":{"type":"string"}},"type":"object"},"String":{"properties":{"bytes":{"$ref":"#/definitions/byte"},"empty":{"type":"boolean"}},"type":"object"},"Subscriptions":{"properties":{"lastModifiedDate":{"format":"date","type":"string"},"subscribed":{"type":"boolean"},"subscription":{"$ref":"#/definitions/RecordRef"}},"type":"object"},"SubscriptionsList":{"properties":{"replaceAll":{"type":"boolean"},"subscriptions":{"$ref":"#/definitions/Subscriptions"}},"type":"object"},"TaxGroupTaxItem":{"properties":{"basis":{"type":"number"},"rate":{"type":"number"},"taxName":{"$ref":"#/definitions/RecordRef"},"taxType":{"type":"string"}},"type":"object"},"TaxGroupTaxItemList":{"properties":{"replaceAll":{"type":"boolean"},"taxItem":{"$ref":"#/definitions/TaxGroupTaxItem"}},"type":"object"},"TaxTypeNexusesTax":{"properties":{"description":{"type":"string"},"nexus":{"$ref":"#/definitions/RecordRef"},"purchTaxAcct":{"$ref":"#/definitions/RecordRef"},"saleTaxAcct":{"$ref":"#/definitions/RecordRef"}},"type":"object"},"TaxTypeNexusesTaxList":{"properties":{"nexusesTax":{"$ref":"#/definitions/TaxTypeNexusesTax"},"replaceAll":{"type":"boolean"}},"type":"object"},"TimeBillTimeType":{"properties":{"value":{"type":"string"}},"type":"object"},"TransactionBillVarianceStatus":{"properties":{"value":{"type":"string"}},"type":"object"},"TransactionShipGroup":{"properties":{"destinationAddress":{"type":"string"},"destinationAddressRef":{"$ref":"#/definitions/RecordRef"},"handlingRate":{"type":"number"},"handlingTax2Amt":{"type":"number"},"handlingTax2Rate":{"type":"string"},"handlingTaxAmt":{"type":"number"},"handlingTaxCode":{"$ref":"#/definitions/RecordRef"},"handlingTaxRate":{"type":"string"},"id":{"type":"number"},"isFulfilled":{"type":"boolean"},"isHandlingTaxable":{"type":"boolean"},"isShippingTaxable":{"type":"boolean"},"shippingMethod":{"type":"string"},"shippingMethodRef":{"$ref":"#/definitions/RecordRef"},"shippingRate":{"type":"number"},"shippingTax2Amt":{"type":"number"},"shippingTax2Rate":{"type":"string"},"shippingTaxAmt":{"type":"number"},"shippingTaxCode":{"$ref":"#/definitions/RecordRef"},"shippingTaxRate":{"type":"string"},"sourceAddress":{"type":"string"},"sourceAddressRef":{"$ref":"#/definitions/RecordRef"},"weight":{"type":"number"}},"type":"object"},"Translation":{"properties":{"description":{"type":"string"},"displayName":{"type":"string"},"featuredDescription":{"type":"string"},"language":{"type":"string"},"locale":{"$ref":"#/definitions/Language"},"noPriceMessage":{"type":"string"},"outOfStockMessage":{"type":"string"},"pageTitle":{"type":"string"},"salesDescription":{"type":"string"},"specialsDescription":{"type":"string"},"storeDescription":{"type":"string"},"storeDetailedDescription":{"type":"string"},"storeDisplayName":{"type":"string"}},"type":"object"},"TranslationList":{"properties":{"replaceAll":{"type":"boolean"},"translation":{"$ref":"#/definitions/Translation"}},"type":"object"},"VendorAddressbook":{"properties":{"addressbookAddress":{"$ref":"#/definitions/Address"},"defaultBilling":{"type":"boolean"},"defaultShipping":{"type":"boolean"},"internalId":{"type":"string"},"label":{"type":"string"}},"type":"object"},"VendorAddressbookList":{"properties":{"addressbook":{"$ref":"#/definitions/VendorAddressbook"},"replaceAll":{"type":"boolean"}},"type":"object"},"VendorCurrency":{"properties":{"balance":{"type":"number"},"currency":{"$ref":"#/definitions/RecordRef"},"unbilledOrders":{"type":"number"}},"type":"object"},"VendorCurrencyList":{"properties":{"replaceAll":{"type":"boolean"},"vendorCurrency":{"$ref":"#/definitions/VendorCurrency"}},"type":"object"},"VendorPaymentApply":{"properties":{"amount":{"type":"number"},"apply":{"type":"boolean"},"applyDate":{"format":"date","type":"string"},"currency":{"type":"string"},"disc":{"type":"number"},"discAmt":{"type":"number"},"discDate":{"format":"date","type":"string"},"doc":{"type":"number"},"due":{"type":"number"},"job":{"type":"string"},"line":{"type":"number"},"refNum":{"type":"string"},"total":{"type":"number"},"type":{"type":"string"}},"type":"object"},"VendorPaymentApplyList":{"properties":{"apply":{"$ref":"#/definitions/VendorPaymentApply"},"replaceAll":{"type":"boolean"}},"type":"object"},"VendorPaymentCredit":{"properties":{"amount":{"type":"number"},"appliedTo":{"type":"string"},"apply":{"type":"boolean"},"creditDate":{"format":"date","type":"string"},"currency":{"type":"string"},"doc":{"type":"number"},"due":{"type":"number"},"line":{"type":"number"},"refNum":{"type":"string"},"total":{"type":"number"},"type":{"type":"string"}},"type":"object"},"VendorPaymentCreditList":{"properties":{"credit":{"$ref":"#/definitions/VendorPaymentCredit"},"replaceAll":{"type":"boolean"}},"type":"object"},"VendorPricingSchedule":{"properties":{"scheduleDiscount":{"type":"number"},"scheduleName":{"type":"string"}},"type":"object"},"VendorPricingScheduleList":{"properties":{"pricingSchedule":{"$ref":"#/definitions/VendorPricingSchedule"},"replaceAll":{"type":"boolean"}},"type":"object"},"VendorRoles":{"properties":{"selectedRole":{"$ref":"#/definitions/RecordRef"}},"type":"object"},"VendorRolesList":{"properties":{"replaceAll":{"type":"boolean"},"roles":{"$ref":"#/definitions/VendorRoles"}},"type":"object"},"VsoeDeferral":{"properties":{"value":{"type":"string"}},"type":"object"},"VsoePermitDiscount":{"properties":{"value":{"type":"string"}},"type":"object"},"VsoeSopGroup":{"properties":{"value":{"type":"string"}},"type":"object"},"byte":{},"contacts":{"properties":{"addressbookList":{"$ref":"#/definitions/ContactAddressbookList"},"altEmail":{"type":"string"},"assistant":{"$ref":"#/definitions/RecordRef"},"assistantPhone":{"type":"string"},"billPay":{"type":"boolean"},"categoryList":{"$ref":"#/definitions/CategoryList"},"comments":{"type":"string"},"company":{"$ref":"#/definitions/RecordRef"},"contactSource":{"$ref":"#/definitions/RecordRef"},"customFieldList":{"$ref":"#/definitions/CustomFieldList"},"customForm":{"$ref":"#/definitions/RecordRef"},"dateCreated":{"format":"date","type":"string"},"defaultAddress":{"type":"string"},"email":{"type":"string"},"entityId":{"type":"string"},"externalId":{"type":"string"},"fax":{"type":"string"},"firstName":{"type":"string"},"globalSubscriptionStatus":{"$ref":"#/definitions/GlobalSubscriptionStatus"},"homePhone":{"type":"string"},"image":{"$ref":"#/definitions/RecordRef"},"internalId":{"type":"string"},"isInactive":{"type":"boolean"},"isPrivate":{"type":"boolean"},"lastModifiedDate":{"format":"date","type":"string"},"lastName":{"type":"string"},"middleName":{"type":"string"},"mobilePhone":{"type":"string"},"nullFieldList":{"$ref":"#/definitions/NullField"},"officePhone":{"type":"string"},"phone":{"type":"string"},"phoneticName":{"type":"string"},"salutation":{"type":"string"},"subscriptionsList":{"$ref":"#/definitions/SubscriptionsList"},"subsidiary":{"$ref":"#/definitions/RecordRef"},"supervisor":{"$ref":"#/definitions/RecordRef"},"supervisorPhone":{"type":"string"},"title":{"type":"string"}},"type":"object"},"creditTerms":{"properties":{"dateDriven":{"type":"boolean"},"dayDiscountExpires":{"type":"number"},"dayOfMonthNetDue":{"type":"number"},"daysUntilExpiry":{"type":"number"},"daysUntilNetDue":{"type":"number"},"discountPercent":{"type":"number"},"discountPercentDateDriven":{"type":"number"},"dueNextMonthIfWithinDays":{"type":"number"},"externalId":{"type":"string"},"internalId":{"type":"string"},"isInactive":{"type":"boolean"},"name":{"type":"string"},"nullFieldList":{"$ref":"#/definitions/NullField"},"preferred":{"type":"boolean"}},"type":"object"},"customers":{"properties":{"accessRole":{"$ref":"#/definitions/RecordRef"},"accountNumber":{"type":"string"},"addressbookList":{"$ref":"#/definitions/CustomerAddressbookList"},"aging":{"type":"number"},"altEmail":{"type":"string"},"altName":{"type":"string"},"altPhone":{"type":"string"},"balance":{"type":"number"},"billPay":{"type":"boolean"},"buyingReason":{"$ref":"#/definitions/RecordRef"},"buyingTimeFrame":{"$ref":"#/definitions/RecordRef"},"campaignCategory":{"$ref":"#/definitions/RecordRef"},"category":{"$ref":"#/definitions/RecordRef"},"clickStream":{"type":"string"},"comments":{"type":"string"},"companyName":{"type":"string"},"consolAging":{"type":"number"},"consolBalance":{"type":"number"},"consolDaysOverdue":{"type":"number"},"consolDepositBalance":{"type":"number"},"consolOverdueBalance":{"type":"number"},"consolUnbilledOrders":{"type":"number"},"contactRolesList":{"$ref":"#/definitions/ContactAccessRolesList"},"contribPct":{"type":"string"},"creditCardsList":{"$ref":"#/definitions/CustomerCreditCardsList"},"creditHoldOverride":{"$ref":"#/definitions/CustomerCreditHoldOverride"},"creditLimit":{"type":"number"},"currency":{"$ref":"#/definitions/RecordRef"},"currencyList":{"$ref":"#/definitions/CustomerCurrencyList"},"customFieldList":{"$ref":"#/definitions/CustomFieldList"},"customForm":{"$ref":"#/definitions/RecordRef"},"dateCreated":{"format":"date","type":"string"},"daysOverdue":{"type":"number"},"defaultAddress":{"type":"string"},"defaultOrderPriority":{"type":"number"},"depositBalance":{"type":"number"},"displaySymbol":{"type":"string"},"downloadList":{"$ref":"#/definitions/CustomerDownloadList"},"drAccount":{"$ref":"#/definitions/RecordRef"},"email":{"type":"string"},"emailPreference":{"$ref":"#/definitions/EmailPreference"},"emailTransactions":{"type":"boolean"},"endDate":{"format":"date","type":"string"},"entityId":{"type":"string"},"entityStatus":{"$ref":"#/definitions/RecordRef"},"estimatedBudget":{"type":"number"},"externalId":{"type":"string"},"fax":{"type":"string"},"faxTransactions":{"type":"boolean"},"firstName":{"type":"string"},"firstVisit":{"format":"date","type":"string"},"fxAccount":{"$ref":"#/definitions/RecordRef"},"giveAccess":{"type":"boolean"},"globalSubscriptionStatus":{"$ref":"#/definitions/GlobalSubscriptionStatus"},"groupPricingList":{"$ref":"#/definitions/CustomerGroupPricingList"},"homePhone":{"type":"string"},"image":{"$ref":"#/definitions/RecordRef"},"internalId":{"type":"string"},"isBudgetApproved":{"type":"boolean"},"isInactive":{"type":"boolean"},"isPerson":{"type":"boolean"},"itemPricingList":{"$ref":"#/definitions/CustomerItemPricingList"},"keywords":{"type":"string"},"language":{"$ref":"#/definitions/Language"},"lastModifiedDate":{"format":"date","type":"string"},"lastName":{"type":"string"},"lastPageVisited":{"type":"string"},"lastVisit":{"format":"date","type":"string"},"leadSource":{"$ref":"#/definitions/RecordRef"},"middleName":{"type":"string"},"mobilePhone":{"type":"string"},"monthlyClosing":{"$ref":"#/definitions/CustomerMonthlyClosing"},"negativeNumberFormat":{"$ref":"#/definitions/CustomerNegativeNumberFormat"},"nullFieldList":{"$ref":"#/definitions/NullField"},"numberFormat":{"$ref":"#/definitions/CustomerNumberFormat"},"openingBalance":{"type":"number"},"openingBalanceAccount":{"$ref":"#/definitions/RecordRef"},"openingBalanceDate":{"format":"date","type":"string"},"overdueBalance":{"type":"number"},"overrideCurrencyFormat":{"type":"boolean"},"parent":{"$ref":"#/definitions/RecordRef"},"partner":{"$ref":"#/definitions/RecordRef"},"partnersList":{"$ref":"#/definitions/CustomerPartnersList"},"password":{"type":"string"},"password2":{"type":"string"},"phone":{"type":"string"},"phoneticName":{"type":"string"},"prefCCProcessor":{"$ref":"#/definitions/RecordRef"},"priceLevel":{"$ref":"#/definitions/RecordRef"},"printOnCheckAs":{"type":"string"},"printTransactions":{"type":"boolean"},"receivablesAccount":{"$ref":"#/definitions/RecordRef"},"referrer":{"type":"string"},"reminderDays":{"type":"number"},"representingSubsidiary":{"$ref":"#/definitions/RecordRef"},"requirePwdChange":{"type":"boolean"},"resaleNumber":{"type":"string"},"salesGroup":{"$ref":"#/definitions/RecordRef"},"salesReadiness":{"$ref":"#/definitions/RecordRef"},"salesRep":{"$ref":"#/definitions/RecordRef"},"salesTeamList":{"$ref":"#/definitions/CustomerSalesTeamList"},"salutation":{"type":"string"},"sendEmail":{"type":"boolean"},"shipComplete":{"type":"boolean"},"shippingItem":{"$ref":"#/definitions/RecordRef"},"stage":{"$ref":"#/definitions/CustomerStage"},"startDate":{"format":"date","type":"string"},"subscriptionsList":{"$ref":"#/definitions/SubscriptionsList"},"subsidiary":{"$ref":"#/definitions/RecordRef"},"symbolPlacement":{"$ref":"#/definitions/CurrencySymbolPlacement"},"syncPartnerTeams":{"type":"boolean"},"taxExempt":{"type":"boolean"},"taxItem":{"$ref":"#/definitions/RecordRef"},"taxable":{"type":"boolean"},"terms":{"$ref":"#/definitions/RecordRef"},"territory":{"$ref":"#/definitions/RecordRef"},"thirdPartyAcct":{"type":"string"},"thirdPartyCountry":{"$ref":"#/definitions/Country"},"thirdPartyZipcode":{"type":"string"},"title":{"type":"string"},"unbilledOrders":{"type":"number"},"url":{"type":"string"},"vatRegNumber":{"type":"string"},"visits":{"type":"number"},"webLead":{"type":"string"}},"type":"object"},"invoices":{"properties":{"_class":{"$ref":"#/definitions/RecordRef"},"account":{"$ref":"#/definitions/RecordRef"},"altHandlingCost":{"type":"number"},"altShippingCost":{"type":"number"},"amountPaid":{"type":"number"},"amountRemaining":{"type":"number"},"approvalStatus":{"$ref":"#/definitions/RecordRef"},"balance":{"type":"number"},"billAddressList":{"$ref":"#/definitions/RecordRef"},"billingAddress":{"$ref":"#/definitions/Address"},"billingSchedule":{"$ref":"#/definitions/RecordRef"},"contribPct":{"type":"string"},"createdDate":{"format":"date","type":"string"},"createdFrom":{"$ref":"#/definitions/RecordRef"},"currency":{"$ref":"#/definitions/RecordRef"},"currencyName":{"type":"string"},"customFieldList":{"$ref":"#/definitions/CustomFieldList"},"customForm":{"$ref":"#/definitions/RecordRef"},"deferredRevenue":{"type":"number"},"department":{"$ref":"#/definitions/RecordRef"},"discountAmount":{"type":"number"},"discountDate":{"format":"date","type":"string"},"discountItem":{"$ref":"#/definitions/RecordRef"},"discountRate":{"type":"string"},"discountTotal":{"type":"number"},"dueDate":{"format":"date","type":"string"},"email":{"type":"string"},"endDate":{"format":"date","type":"string"},"entity":{"$ref":"#/definitions/RecordRef"},"estGrossProfit":{"type":"number"},"estGrossProfitPercent":{"type":"number"},"exchangeRate":{"type":"number"},"excludeCommission":{"type":"boolean"},"expCostDiscAmount":{"type":"number"},"expCostDiscPrint":{"type":"boolean"},"expCostDiscRate":{"type":"string"},"expCostDiscTax1Amt":{"type":"number"},"expCostDiscTaxable":{"type":"boolean"},"expCostDiscount":{"$ref":"#/definitions/RecordRef"},"expCostList":{"$ref":"#/definitions/InvoiceExpCostList"},"expCostTaxCode":{"$ref":"#/definitions/RecordRef"},"expCostTaxRate1":{"type":"number"},"expCostTaxRate2":{"type":"number"},"externalId":{"type":"string"},"fax":{"type":"string"},"fob":{"type":"string"},"giftCertApplied":{"type":"number"},"giftCertRedemptionList":{"$ref":"#/definitions/GiftCertRedemptionList"},"handlingCost":{"type":"number"},"handlingTax1Rate":{"type":"number"},"handlingTax2Rate":{"type":"string"},"handlingTaxCode":{"$ref":"#/definitions/RecordRef"},"internalId":{"type":"string"},"isTaxable":{"type":"boolean"},"itemCostDiscAmount":{"type":"number"},"itemCostDiscPrint":{"type":"boolean"},"itemCostDiscRate":{"type":"string"},"itemCostDiscTax1Amt":{"type":"number"},"itemCostDiscTaxable":{"type":"boolean"},"itemCostDiscount":{"$ref":"#/definitions/RecordRef"},"itemCostList":{"$ref":"#/definitions/InvoiceItemCostList"},"itemCostTaxCode":{"$ref":"#/definitions/RecordRef"},"itemCostTaxRate1":{"type":"number"},"itemCostTaxRate2":{"type":"number"},"itemList":{"$ref":"#/definitions/InvoiceItemList"},"job":{"$ref":"#/definitions/RecordRef"},"lastModifiedDate":{"format":"date","type":"string"},"leadSource":{"$ref":"#/definitions/RecordRef"},"linkedTrackingNumbers":{"type":"string"},"location":{"$ref":"#/definitions/RecordRef"},"memo":{"type":"string"},"message":{"type":"string"},"messageSel":{"$ref":"#/definitions/RecordRef"},"nextApprover":{"$ref":"#/definitions/RecordRef"},"nullFieldList":{"$ref":"#/definitions/NullField"},"onCreditHold":{"type":"string"},"opportunity":{"$ref":"#/definitions/RecordRef"},"otherRefNum":{"type":"string"},"partner":{"$ref":"#/definitions/RecordRef"},"partnersList":{"$ref":"#/definitions/InvoicePartnersList"},"postingPeriod":{"$ref":"#/definitions/RecordRef"},"promoCode":{"$ref":"#/definitions/RecordRef"},"recognizedRevenue":{"type":"number"},"revRecEndDate":{"format":"date","type":"string"},"revRecOnRevCommitment":{"type":"boolean"},"revRecSchedule":{"$ref":"#/definitions/RecordRef"},"revRecStartDate":{"format":"date","type":"string"},"revenueStatus":{"$ref":"#/definitions/RevenueStatus"},"salesEffectiveDate":{"format":"date","type":"string"},"salesGroup":{"$ref":"#/definitions/RecordRef"},"salesRep":{"$ref":"#/definitions/RecordRef"},"salesTeamList":{"$ref":"#/definitions/InvoiceSalesTeamList"},"shipAddressList":{"$ref":"#/definitions/RecordRef"},"shipDate":{"format":"date","type":"string"},"shipGroupList":{"$ref":"#/definitions/InvoiceShipGroupList"},"shipIsResidential":{"type":"boolean"},"shipMethod":{"$ref":"#/definitions/RecordRef"},"shippingAddress":{"$ref":"#/definitions/Address"},"shippingCost":{"type":"number"},"shippingTax1Rate":{"type":"number"},"shippingTax2Rate":{"type":"string"},"shippingTaxCode":{"$ref":"#/definitions/RecordRef"},"source":{"type":"string"},"startDate":{"format":"date","type":"string"},"status":{"type":"string"},"subTotal":{"type":"number"},"subsidiary":{"$ref":"#/definitions/RecordRef"},"syncPartnerTeams":{"type":"boolean"},"syncSalesTeams":{"type":"boolean"},"tax2Total":{"type":"number"},"taxItem":{"$ref":"#/definitions/RecordRef"},"taxRate":{"type":"number"},"taxTotal":{"type":"number"},"terms":{"$ref":"#/definitions/RecordRef"},"timeDiscAmount":{"type":"number"},"timeDiscPrint":{"type":"boolean"},"timeDiscRate":{"type":"string"},"timeDiscTax1Amt":{"type":"number"},"timeDiscTaxable":{"type":"boolean"},"timeDiscount":{"$ref":"#/definitions/RecordRef"},"timeList":{"$ref":"#/definitions/InvoiceTimeList"},"timeTaxCode":{"$ref":"#/definitions/RecordRef"},"timeTaxRate1":{"type":"number"},"timeTaxRate2":{"type":"number"},"toBeEmailed":{"type":"boolean"},"toBeFaxed":{"type":"boolean"},"toBePrinted":{"type":"boolean"},"total":{"type":"number"},"totalCostEstimate":{"type":"number"},"trackingNumbers":{"type":"string"},"tranDate":{"format":"date","type":"string"},"tranId":{"type":"string"},"tranIsVsoeBundle":{"type":"boolean"},"vatRegNum":{"type":"string"},"vsoeAutoCalc":{"type":"boolean"}},"type":"object"},"journalEntries":{"properties":{"_class":{"$ref":"#/definitions/RecordRef"},"accountingBook":{"$ref":"#/definitions/RecordRef"},"approved":{"type":"boolean"},"createdDate":{"format":"date","type":"string"},"createdFrom":{"$ref":"#/definitions/RecordRef"},"currency":{"$ref":"#/definitions/RecordRef"},"customFieldList":{"$ref":"#/definitions/CustomFieldList"},"customForm":{"$ref":"#/definitions/RecordRef"},"department":{"$ref":"#/definitions/RecordRef"},"exchangeRate":{"type":"number"},"externalId":{"type":"string"},"internalId":{"type":"string"},"isBookSpecific":{"type":"boolean"},"lastModifiedDate":{"format":"date","type":"string"},"lineList":{"$ref":"#/definitions/JournalEntryLineList"},"location":{"$ref":"#/definitions/RecordRef"},"nullFieldList":{"$ref":"#/definitions/NullField"},"parentExpenseAlloc":{"$ref":"#/definitions/RecordRef"},"postingPeriod":{"$ref":"#/definitions/RecordRef"},"reversalDate":{"format":"date","type":"string"},"reversalDefer":{"type":"boolean"},"reversalEntry":{"type":"string"},"subsidiary":{"$ref":"#/definitions/RecordRef"},"toSubsidiary":{"$ref":"#/definitions/RecordRef"},"tranDate":{"format":"date","type":"string"},"tranId":{"type":"string"}},"type":"object"},"ledgerAccounts":{"properties":{"_class":{"$ref":"#/definitions/RecordRef"},"acctName":{"type":"string"},"acctNumber":{"type":"string"},"acctType":{"$ref":"#/definitions/AccountType"},"billableExpensesAcct":{"$ref":"#/definitions/RecordRef"},"cashFlowRate":{"$ref":"#/definitions/ConsolidatedRate"},"category1099Misc":{"$ref":"#/definitions/RecordRef"},"curDocNum":{"type":"number"},"currency":{"$ref":"#/definitions/RecordRef"},"customFieldList":{"$ref":"#/definitions/CustomFieldList"},"deferralAcct":{"$ref":"#/definitions/RecordRef"},"department":{"$ref":"#/definitions/RecordRef"},"description":{"type":"string"},"eliminate":{"type":"boolean"},"exchangeRate":{"type":"string"},"externalId":{"type":"string"},"generalRate":{"$ref":"#/definitions/ConsolidatedRate"},"includeChildren":{"type":"boolean"},"internalId":{"type":"string"},"inventory":{"type":"boolean"},"isInactive":{"type":"boolean"},"location":{"$ref":"#/definitions/RecordRef"},"nullFieldList":{"$ref":"#/definitions/NullField"},"openingBalance":{"type":"number"},"parent":{"$ref":"#/definitions/RecordRef"},"revalue":{"type":"boolean"},"subsidiaryList":{"$ref":"#/definitions/RecordRefList"},"tranDate":{"format":"date","type":"string"},"translationsList":{"$ref":"#/definitions/AccountTranslationList"},"unit":{"$ref":"#/definitions/RecordRef"},"unitsType":{"$ref":"#/definitions/RecordRef"}},"type":"object"},"opportunities":{"properties":{"_class":{"$ref":"#/definitions/RecordRef"},"actionItem":{"type":"string"},"altSalesRangeHigh":{"type":"number"},"altSalesRangeLow":{"type":"number"},"billAddressList":{"$ref":"#/definitions/RecordRef"},"billingAddress":{"$ref":"#/definitions/Address"},"buyingReason":{"$ref":"#/definitions/RecordRef"},"buyingTimeFrame":{"$ref":"#/definitions/RecordRef"},"closeDate":{"format":"date","type":"string"},"competitorsList":{"$ref":"#/definitions/OpportunityCompetitorsList"},"contribPct":{"type":"string"},"createdDate":{"format":"date","type":"string"},"currency":{"$ref":"#/definitions/RecordRef"},"currencyName":{"type":"string"},"customFieldList":{"$ref":"#/definitions/CustomFieldList"},"customForm":{"$ref":"#/definitions/RecordRef"},"daysOpen":{"type":"number"},"department":{"$ref":"#/definitions/RecordRef"},"entity":{"$ref":"#/definitions/RecordRef"},"entityStatus":{"$ref":"#/definitions/RecordRef"},"estGrossProfit":{"type":"number"},"estGrossProfitPercent":{"type":"number"},"estimatedBudget":{"type":"number"},"exchangeRate":{"type":"number"},"expectedCloseDate":{"format":"date","type":"string"},"externalId":{"type":"string"},"forecastType":{"$ref":"#/definitions/RecordRef"},"internalId":{"type":"string"},"isBudgetApproved":{"type":"boolean"},"itemList":{"$ref":"#/definitions/OpportunityItemList"},"job":{"$ref":"#/definitions/RecordRef"},"lastModifiedDate":{"format":"date","type":"string"},"leadSource":{"$ref":"#/definitions/RecordRef"},"location":{"$ref":"#/definitions/RecordRef"},"memo":{"type":"string"},"nullFieldList":{"$ref":"#/definitions/NullField"},"partner":{"$ref":"#/definitions/RecordRef"},"partnersList":{"$ref":"#/definitions/OpportunityPartnersList"},"probability":{"type":"number"},"projAltSalesAmt":{"type":"number"},"projectedTotal":{"type":"number"},"rangeHigh":{"type":"number"},"rangeLow":{"type":"number"},"salesGroup":{"$ref":"#/definitions/RecordRef"},"salesReadiness":{"$ref":"#/definitions/RecordRef"},"salesRep":{"$ref":"#/definitions/RecordRef"},"salesTeamList":{"$ref":"#/definitions/OpportunitySalesTeamList"},"shipAddressList":{"$ref":"#/definitions/RecordRef"},"shipIsResidential":{"type":"boolean"},"shippingAddress":{"$ref":"#/definitions/Address"},"source":{"type":"string"},"status":{"type":"string"},"subsidiary":{"$ref":"#/definitions/RecordRef"},"syncPartnerTeams":{"type":"boolean"},"syncSalesTeams":{"type":"boolean"},"tax2Total":{"type":"number"},"taxTotal":{"type":"number"},"title":{"type":"string"},"totalCostEstimate":{"type":"number"},"tranDate":{"format":"date","type":"string"},"tranId":{"type":"string"},"vatRegNum":{"type":"string"},"weightedTotal":{"type":"number"},"winLossReason":{"$ref":"#/definitions/RecordRef"}},"type":"object"},"paymentMethods":{"properties":{"account":{"$ref":"#/definitions/RecordRef"},"creditCard":{"type":"boolean"},"expressCheckoutArrangement":{"type":"string"},"externalId":{"type":"string"},"internalId":{"type":"string"},"isDebitCard":{"type":"boolean"},"isInactive":{"type":"boolean"},"isOnline":{"type":"boolean"},"merchantAccountsList":{"$ref":"#/definitions/RecordRefList"},"name":{"type":"string"},"nullFieldList":{"$ref":"#/definitions/NullField"},"payPalEmailAddress":{"type":"string"},"undepFunds":{"type":"boolean"},"useExpressCheckout":{"type":"boolean"},"visualsList":{"$ref":"#/definitions/PaymentMethodVisualsList"}},"type":"object"},"payments":{"properties":{"_class":{"$ref":"#/definitions/RecordRef"},"account":{"$ref":"#/definitions/RecordRef"},"applied":{"type":"number"},"applyList":{"$ref":"#/definitions/CustomerPaymentApplyList"},"arAcct":{"$ref":"#/definitions/RecordRef"},"authCode":{"type":"string"},"autoApply":{"type":"boolean"},"balance":{"type":"number"},"ccApproved":{"type":"boolean"},"ccAvsStreetMatch":{"$ref":"#/definitions/AvsMatchCode"},"ccAvsZipMatch":{"$ref":"#/definitions/AvsMatchCode"},"ccExpireDate":{"format":"date","type":"string"},"ccIsPurchaseCardBin":{"type":"boolean"},"ccName":{"type":"string"},"ccNumber":{"type":"string"},"ccProcessAsPurchaseCard":{"type":"boolean"},"ccSecurityCode":{"type":"string"},"ccSecurityCodeMatch":{"$ref":"#/definitions/AvsMatchCode"},"ccStreet":{"type":"string"},"ccZipCode":{"type":"string"},"chargeIt":{"type":"boolean"},"checkNum":{"type":"string"},"createdDate":{"format":"date","type":"string"},"creditCard":{"$ref":"#/definitions/RecordRef"},"creditCardProcessor":{"$ref":"#/definitions/RecordRef"},"creditList":{"$ref":"#/definitions/CustomerPaymentCreditList"},"currency":{"$ref":"#/definitions/RecordRef"},"currencyName":{"type":"string"},"customFieldList":{"$ref":"#/definitions/CustomFieldList"},"customForm":{"$ref":"#/definitions/RecordRef"},"customer":{"$ref":"#/definitions/RecordRef"},"debitCardIssueNo":{"type":"string"},"department":{"$ref":"#/definitions/RecordRef"},"depositList":{"$ref":"#/definitions/CustomerPaymentDepositList"},"exchangeRate":{"type":"number"},"externalId":{"type":"string"},"ignoreAvs":{"type":"boolean"},"internalId":{"type":"string"},"isRecurringPayment":{"type":"boolean"},"lastModifiedDate":{"format":"date","type":"string"},"location":{"$ref":"#/definitions/RecordRef"},"memo":{"type":"string"},"nullFieldList":{"$ref":"#/definitions/NullField"},"payment":{"type":"number"},"paymentMethod":{"$ref":"#/definitions/RecordRef"},"pending":{"type":"number"},"pnRefNum":{"type":"string"},"postingPeriod":{"$ref":"#/definitions/RecordRef"},"status":{"type":"string"},"subsidiary":{"$ref":"#/definitions/RecordRef"},"threeDStatusCode":{"type":"string"},"total":{"type":"number"},"tranDate":{"format":"date","type":"string"},"unapplied":{"type":"number"},"undepFunds":{"type":"boolean"},"validFrom":{"format":"date","type":"string"}},"type":"object"},"products":{"properties":{"_class":{"$ref":"#/definitions/RecordRef"},"accountingBookDetailList":{"$ref":"#/definitions/ItemAccountingBookDetailList"},"alternateDemandSourceItem":{"$ref":"#/definitions/RecordRef"},"assetAccount":{"$ref":"#/definitions/RecordRef"},"autoLeadTime":{"type":"boolean"},"autoPreferredStockLevel":{"type":"boolean"},"autoReorderPoint":{"type":"boolean"},"availableToPartners":{"type":"boolean"},"averageCost":{"type":"number"},"backwardConsumptionDays":{"type":"number"},"billExchRateVarianceAcct":{"$ref":"#/definitions/RecordRef"},"billPriceVarianceAcct":{"$ref":"#/definitions/RecordRef"},"billQtyVarianceAcct":{"$ref":"#/definitions/RecordRef"},"billingSchedule":{"$ref":"#/definitions/RecordRef"},"binNumberList":{"$ref":"#/definitions/InventoryItemBinNumberList"},"cogsAccount":{"$ref":"#/definitions/RecordRef"},"copyDescription":{"type":"boolean"},"cost":{"type":"number"},"costCategory":{"$ref":"#/definitions/RecordRef"},"costEstimate":{"type":"number"},"costEstimateType":{"$ref":"#/definitions/ItemCostEstimateType"},"costEstimateUnits":{"type":"string"},"costUnits":{"type":"string"},"costingMethod":{"$ref":"#/definitions/ItemCostingMethod"},"costingMethodDisplay":{"type":"string"},"countryOfManufacture":{"$ref":"#/definitions/Country"},"createdDate":{"format":"date","type":"string"},"currency":{"type":"string"},"customFieldList":{"$ref":"#/definitions/CustomFieldList"},"customForm":{"$ref":"#/definitions/RecordRef"},"dateConvertedToInv":{"format":"date","type":"string"},"defaultItemShipMethod":{"$ref":"#/definitions/RecordRef"},"defaultReturnCost":{"type":"number"},"deferRevRec":{"type":"boolean"},"deferredRevenueAccount":{"$ref":"#/definitions/RecordRef"},"demandModifier":{"type":"number"},"demandSource":{"$ref":"#/definitions/RecordRef"},"demandTimeFence":{"type":"number"},"department":{"$ref":"#/definitions/RecordRef"},"displayName":{"type":"string"},"distributionCategory":{"$ref":"#/definitions/RecordRef"},"distributionNetwork":{"$ref":"#/definitions/RecordRef"},"dontShowPrice":{"type":"boolean"},"dropshipExpenseAccount":{"$ref":"#/definitions/RecordRef"},"enforceMinQtyInternally":{"type":"boolean"},"excludeFromSitemap":{"type":"boolean"},"expenseAccount":{"$ref":"#/definitions/RecordRef"},"externalId":{"type":"string"},"featuredDescription":{"type":"string"},"fixedLotSize":{"type":"number"},"forwardConsumptionDays":{"type":"number"},"fraudRisk":{"$ref":"#/definitions/InventoryItemFraudRisk"},"gainLossAccount":{"$ref":"#/definitions/RecordRef"},"handlingCost":{"type":"number"},"handlingCostUnits":{"type":"string"},"hazmatHazardClass":{"type":"string"},"hazmatId":{"type":"string"},"hazmatItemUnits":{"type":"string"},"hazmatItemUnitsQty":{"type":"number"},"hazmatPackingGroup":{"$ref":"#/definitions/HazmatPackingGroup"},"hazmatShippingName":{"type":"string"},"includeChildren":{"type":"boolean"},"incomeAccount":{"$ref":"#/definitions/RecordRef"},"internalId":{"type":"string"},"invtClassification":{"$ref":"#/definitions/ItemInvtClassification"},"invtCountInterval":{"type":"number"},"isDonationItem":{"type":"boolean"},"isDropShipItem":{"type":"boolean"},"isGcoCompliant":{"type":"boolean"},"isHazmatItem":{"type":"boolean"},"isInactive":{"type":"boolean"},"isOnline":{"type":"boolean"},"isSpecialOrderItem":{"type":"boolean"},"isTaxable":{"type":"boolean"},"issueProduct":{"$ref":"#/definitions/RecordRef"},"itemCarrier":{"$ref":"#/definitions/ItemCarrier"},"itemId":{"type":"string"},"itemOptionsList":{"$ref":"#/definitions/ItemOptionsList"},"itemShipMethodList":{"$ref":"#/definitions/RecordRefList"},"itemVendorList":{"$ref":"#/definitions/ItemVendorList"},"lastInvtCountDate":{"format":"date","type":"string"},"lastModifiedDate":{"format":"date","type":"string"},"lastPurchasePrice":{"type":"number"},"leadTime":{"type":"number"},"location":{"$ref":"#/definitions/RecordRef"},"locationsList":{"$ref":"#/definitions/InventoryItemLocationsList"},"manufacturer":{"type":"string"},"manufacturerAddr1":{"type":"string"},"manufacturerCity":{"type":"string"},"manufacturerState":{"type":"string"},"manufacturerTariff":{"type":"string"},"manufacturerTaxId":{"type":"string"},"manufacturerZip":{"type":"string"},"matchBillToReceipt":{"type":"boolean"},"matrixOptionList":{"$ref":"#/definitions/MatrixOptionList"},"matrixType":{"$ref":"#/definitions/ItemMatrixType"},"maxDonationAmount":{"type":"number"},"metaTagHtml":{"type":"string"},"minimumQuantity":{"type":"number"},"minimumQuantityUnits":{"type":"string"},"mpn":{"type":"string"},"multManufactureAddr":{"type":"boolean"},"nexTagCategory":{"type":"string"},"nextInvtCountDate":{"format":"date","type":"string"},"noPriceMessage":{"type":"string"},"nullFieldList":{"$ref":"#/definitions/NullField"},"offerSupport":{"type":"boolean"},"onHandValueMli":{"type":"number"},"onSpecial":{"type":"boolean"},"originalItemSubtype":{"$ref":"#/definitions/ItemSubType"},"originalItemType":{"$ref":"#/definitions/ItemType"},"outOfStockBehavior":{"$ref":"#/definitions/ItemOutOfStockBehavior"},"outOfStockMessage":{"type":"string"},"overallQuantityPricingType":{"$ref":"#/definitions/ItemOverallQuantityPricingType"},"pageTitle":{"type":"string"},"parent":{"$ref":"#/definitions/RecordRef"},"periodicLotSizeDays":{"type":"number"},"periodicLotSizeType":{"$ref":"#/definitions/PeriodicLotSizeType"},"preferenceCriterion":{"$ref":"#/definitions/ItemPreferenceCriterion"},"preferredLocation":{"$ref":"#/definitions/RecordRef"},"preferredStockLevel":{"type":"number"},"preferredStockLevelDays":{"type":"number"},"preferredStockLevelUnits":{"type":"string"},"presentationItemList":{"$ref":"#/definitions/PresentationItemList"},"pricesIncludeTax":{"type":"boolean"},"pricingGroup":{"$ref":"#/definitions/RecordRef"},"pricingMatrix":{"$ref":"#/definitions/PricingMatrix"},"producer":{"type":"boolean"},"productFeedList":{"$ref":"#/definitions/ProductFeedList"},"purchaseDescription":{"type":"string"},"purchaseOrderAmount":{"type":"number"},"purchaseOrderQuantity":{"type":"number"},"purchaseOrderQuantityDiff":{"type":"number"},"purchasePriceVarianceAcct":{"$ref":"#/definitions/RecordRef"},"purchaseTaxCode":{"$ref":"#/definitions/RecordRef"},"purchaseUnit":{"$ref":"#/definitions/RecordRef"},"quantityAvailable":{"type":"number"},"quantityAvailableUnits":{"type":"string"},"quantityBackOrdered":{"type":"number"},"quantityCommitted":{"type":"number"},"quantityCommittedUnits":{"type":"string"},"quantityOnHand":{"type":"number"},"quantityOnHandUnits":{"type":"string"},"quantityOnOrder":{"type":"number"},"quantityOnOrderUnits":{"type":"string"},"quantityPricingSchedule":{"$ref":"#/definitions/RecordRef"},"quantityReorderUnits":{"type":"string"},"rate":{"type":"number"},"receiptAmount":{"type":"number"},"receiptQuantity":{"type":"number"},"receiptQuantityDiff":{"type":"number"},"relatedItemsDescription":{"type":"string"},"reorderMultiple":{"type":"number"},"reorderPoint":{"type":"number"},"reorderPointUnits":{"type":"string"},"rescheduleInDays":{"type":"number"},"rescheduleOutDays":{"type":"number"},"revRecSchedule":{"$ref":"#/definitions/RecordRef"},"roundUpAsComponent":{"type":"boolean"},"safetyStockLevel":{"type":"number"},"safetyStockLevelDays":{"type":"number"},"safetyStockLevelUnits":{"type":"string"},"saleUnit":{"$ref":"#/definitions/RecordRef"},"salesDescription":{"type":"string"},"salesTaxCode":{"$ref":"#/definitions/RecordRef"},"scheduleBCode":{"$ref":"#/definitions/ScheduleBCode"},"scheduleBNumber":{"type":"string"},"scheduleBQuantity":{"type":"number"},"searchKeywords":{"type":"string"},"seasonalDemand":{"type":"boolean"},"shipIndividually":{"type":"boolean"},"shipPackage":{"$ref":"#/definitions/RecordRef"},"shippingCost":{"type":"number"},"shippingCostUnits":{"type":"string"},"shoppingDotComCategory":{"type":"string"},"shopzillaCategoryId":{"type":"number"},"showDefaultDonationAmount":{"type":"boolean"},"siteCategoryList":{"$ref":"#/definitions/SiteCategoryList"},"sitemapPriority":{"$ref":"#/definitions/SitemapPriority"},"softDescriptor":{"$ref":"#/definitions/RecordRef"},"specialsDescription":{"type":"string"},"stockDescription":{"type":"string"},"stockUnit":{"$ref":"#/definitions/RecordRef"},"storeDescription":{"type":"string"},"storeDetailedDescription":{"type":"string"},"storeDisplayImage":{"$ref":"#/definitions/RecordRef"},"storeDisplayName":{"type":"string"},"storeDisplayThumbnail":{"$ref":"#/definitions/RecordRef"},"storeItemTemplate":{"$ref":"#/definitions/RecordRef"},"subsidiaryList":{"$ref":"#/definitions/RecordRefList"},"supplyLotSizingMethod":{"$ref":"#/definitions/RecordRef"},"supplyReplenishmentMethod":{"$ref":"#/definitions/RecordRef"},"supplyTimeFence":{"type":"number"},"supplyType":{"$ref":"#/definitions/RecordRef"},"taxSchedule":{"$ref":"#/definitions/RecordRef"},"totalValue":{"type":"number"},"trackLandedCost":{"type":"boolean"},"transferPrice":{"type":"number"},"translationsList":{"$ref":"#/definitions/TranslationList"},"unitsType":{"$ref":"#/definitions/RecordRef"},"upcCode":{"type":"string"},"urlComponent":{"type":"string"},"useBins":{"type":"boolean"},"useMarginalRates":{"type":"boolean"},"vendor":{"$ref":"#/definitions/RecordRef"},"vendorName":{"type":"string"},"vsoeDeferral":{"$ref":"#/definitions/VsoeDeferral"},"vsoeDelivered":{"type":"boolean"},"vsoePermitDiscount":{"$ref":"#/definitions/VsoePermitDiscount"},"vsoePrice":{"type":"number"},"vsoeSopGroup":{"$ref":"#/definitions/VsoeSopGroup"},"weight":{"type":"number"},"weightUnit":{"$ref":"#/definitions/ItemWeightUnit"},"weightUnits":{"type":"string"}},"type":"object"},"purchaseOrders":{"properties":{"_class":{"$ref":"#/definitions/RecordRef"},"approvalStatus":{"$ref":"#/definitions/RecordRef"},"billAddressList":{"$ref":"#/definitions/RecordRef"},"billingAddress":{"$ref":"#/definitions/Address"},"createdDate":{"format":"date","type":"string"},"createdFrom":{"$ref":"#/definitions/RecordRef"},"currency":{"$ref":"#/definitions/RecordRef"},"currencyName":{"type":"string"},"customFieldList":{"$ref":"#/definitions/CustomFieldList"},"customForm":{"$ref":"#/definitions/RecordRef"},"department":{"$ref":"#/definitions/RecordRef"},"dueDate":{"format":"date","type":"string"},"email":{"type":"string"},"employee":{"$ref":"#/definitions/RecordRef"},"entity":{"$ref":"#/definitions/RecordRef"},"exchangeRate":{"type":"number"},"expenseList":{"$ref":"#/definitions/PurchaseOrderExpenseList"},"externalId":{"type":"string"},"fax":{"type":"string"},"fob":{"type":"string"},"intercoStatus":{"$ref":"#/definitions/IntercoStatus"},"intercoTransaction":{"$ref":"#/definitions/RecordRef"},"internalId":{"type":"string"},"itemList":{"$ref":"#/definitions/PurchaseOrderItemList"},"lastModifiedDate":{"format":"date","type":"string"},"linkedTrackingNumbers":{"type":"string"},"location":{"$ref":"#/definitions/RecordRef"},"memo":{"type":"string"},"message":{"type":"string"},"nextApprover":{"$ref":"#/definitions/RecordRef"},"nullFieldList":{"$ref":"#/definitions/NullField"},"orderStatus":{"$ref":"#/definitions/PurchaseOrderOrderStatus"},"otherRefNum":{"type":"string"},"purchaseContract":{"$ref":"#/definitions/RecordRef"},"shipAddressList":{"$ref":"#/definitions/RecordRef"},"shipDate":{"format":"date","type":"string"},"shipIsResidential":{"type":"boolean"},"shipMethod":{"$ref":"#/definitions/RecordRef"},"shipTo":{"$ref":"#/definitions/RecordRef"},"shippingAddress":{"$ref":"#/definitions/Address"},"source":{"type":"string"},"status":{"type":"string"},"subTotal":{"type":"number"},"subsidiary":{"$ref":"#/definitions/RecordRef"},"supervisorApproval":{"type":"boolean"},"tax2Total":{"type":"number"},"taxTotal":{"type":"number"},"terms":{"$ref":"#/definitions/RecordRef"},"toBeEmailed":{"type":"boolean"},"toBeFaxed":{"type":"boolean"},"toBePrinted":{"type":"boolean"},"total":{"type":"number"},"trackingNumbers":{"type":"string"},"tranDate":{"format":"date","type":"string"},"tranId":{"type":"string"},"vatRegNum":{"type":"string"}},"type":"object"},"taxCodes":{"properties":{"description":{"type":"string"},"externalId":{"type":"string"},"internalId":{"type":"string"},"name":{"type":"string"},"nexusesTaxList":{"$ref":"#/definitions/TaxTypeNexusesTaxList"},"nullFieldList":{"$ref":"#/definitions/NullField"}},"type":"object"},"taxRates":{"properties":{"city":{"type":"string"},"county":{"type":"string"},"description":{"type":"string"},"externalId":{"type":"string"},"includeChildren":{"type":"boolean"},"internalId":{"type":"string"},"isDefault":{"type":"boolean"},"isInactive":{"type":"boolean"},"itemId":{"type":"string"},"nexusCountry":{"$ref":"#/definitions/RecordRef"},"nullFieldList":{"$ref":"#/definitions/NullField"},"piggyback":{"type":"boolean"},"rate":{"type":"number"},"state":{"type":"string"},"subsidiaryList":{"$ref":"#/definitions/RecordRefList"},"taxItemList":{"$ref":"#/definitions/TaxGroupTaxItemList"},"taxType":{"$ref":"#/definitions/RecordRef"},"taxitem1":{"$ref":"#/definitions/RecordRef"},"taxitem2":{"$ref":"#/definitions/RecordRef"},"unitprice1":{"type":"string"},"unitprice2":{"type":"string"},"zip":{"type":"string"}},"type":"object"},"timeActivities":{"properties":{"_class":{"$ref":"#/definitions/RecordRef"},"caseTaskEvent":{"$ref":"#/definitions/RecordRef"},"createdDate":{"format":"date","type":"string"},"customFieldList":{"$ref":"#/definitions/CustomFieldList"},"customForm":{"$ref":"#/definitions/RecordRef"},"customer":{"$ref":"#/definitions/RecordRef"},"department":{"$ref":"#/definitions/RecordRef"},"employee":{"$ref":"#/definitions/RecordRef"},"externalId":{"type":"string"},"hours":{"$ref":"#/definitions/Duration"},"internalId":{"type":"string"},"isBillable":{"type":"boolean"},"item":{"$ref":"#/definitions/RecordRef"},"lastModifiedDate":{"format":"date","type":"string"},"location":{"$ref":"#/definitions/RecordRef"},"memo":{"type":"string"},"nullFieldList":{"$ref":"#/definitions/NullField"},"overrideRate":{"type":"boolean"},"paidExternally":{"type":"boolean"},"payrollItem":{"$ref":"#/definitions/RecordRef"},"price":{"$ref":"#/definitions/RecordRef"},"rate":{"type":"number"},"status":{"type":"string"},"subsidiary":{"$ref":"#/definitions/RecordRef"},"supervisorApproval":{"type":"boolean"},"temporaryLocalJurisdiction":{"$ref":"#/definitions/RecordRef"},"temporaryStateJurisdiction":{"$ref":"#/definitions/RecordRef"},"timeType":{"$ref":"#/definitions/TimeBillTimeType"},"tranDate":{"format":"date","type":"string"},"workplace":{"$ref":"#/definitions/RecordRef"}},"type":"object"},"vendorPayments":{"properties":{"_class":{"$ref":"#/definitions/RecordRef"},"account":{"$ref":"#/definitions/RecordRef"},"address":{"type":"string"},"apAcct":{"$ref":"#/definitions/RecordRef"},"applyList":{"$ref":"#/definitions/VendorPaymentApplyList"},"balance":{"type":"number"},"billPay":{"type":"boolean"},"createdDate":{"format":"date","type":"string"},"creditList":{"$ref":"#/definitions/VendorPaymentCreditList"},"currency":{"$ref":"#/definitions/RecordRef"},"currencyName":{"type":"string"},"customFieldList":{"$ref":"#/definitions/CustomFieldList"},"customForm":{"$ref":"#/definitions/RecordRef"},"department":{"$ref":"#/definitions/RecordRef"},"entity":{"$ref":"#/definitions/RecordRef"},"exchangeRate":{"type":"number"},"externalId":{"type":"string"},"internalId":{"type":"string"},"lastModifiedDate":{"format":"date","type":"string"},"location":{"$ref":"#/definitions/RecordRef"},"memo":{"type":"string"},"nullFieldList":{"$ref":"#/definitions/NullField"},"postingPeriod":{"$ref":"#/definitions/RecordRef"},"printVoucher":{"type":"boolean"},"status":{"type":"string"},"subsidiary":{"$ref":"#/definitions/RecordRef"},"toAch":{"type":"boolean"},"toBePrinted":{"type":"boolean"},"total":{"type":"number"},"tranDate":{"format":"date","type":"string"},"tranId":{"type":"string"},"transactionNumber":{"type":"string"},"voidJournal":{"$ref":"#/definitions/RecordRef"}},"type":"object"},"vendors":{"properties":{"accountNumber":{"type":"string"},"addressbookList":{"$ref":"#/definitions/VendorAddressbookList"},"altEmail":{"type":"string"},"altName":{"type":"string"},"altPhone":{"type":"string"},"balance":{"type":"number"},"balancePrimary":{"type":"number"},"bcn":{"type":"string"},"billPay":{"type":"boolean"},"category":{"$ref":"#/definitions/RecordRef"},"comments":{"type":"string"},"companyName":{"type":"string"},"creditLimit":{"type":"number"},"currency":{"$ref":"#/definitions/RecordRef"},"currencyList":{"$ref":"#/definitions/VendorCurrencyList"},"customFieldList":{"$ref":"#/definitions/CustomFieldList"},"customForm":{"$ref":"#/definitions/RecordRef"},"dateCreated":{"format":"date","type":"string"},"defaultAddress":{"type":"string"},"eligibleForCommission":{"type":"boolean"},"email":{"type":"string"},"emailPreference":{"$ref":"#/definitions/EmailPreference"},"emailTransactions":{"type":"boolean"},"entityId":{"type":"string"},"expenseAccount":{"$ref":"#/definitions/RecordRef"},"externalId":{"type":"string"},"fax":{"type":"string"},"faxTransactions":{"type":"boolean"},"firstName":{"type":"string"},"giveAccess":{"type":"boolean"},"globalSubscriptionStatus":{"$ref":"#/definitions/GlobalSubscriptionStatus"},"homePhone":{"type":"string"},"image":{"$ref":"#/definitions/RecordRef"},"internalId":{"type":"string"},"is1099Eligible":{"type":"boolean"},"isAccountant":{"type":"boolean"},"isInactive":{"type":"boolean"},"isJobResourceVend":{"type":"boolean"},"isPerson":{"type":"boolean"},"laborCost":{"type":"number"},"lastModifiedDate":{"format":"date","type":"string"},"lastName":{"type":"string"},"legalName":{"type":"string"},"middleName":{"type":"string"},"mobilePhone":{"type":"string"},"nullFieldList":{"$ref":"#/definitions/NullField"},"openingBalance":{"type":"number"},"openingBalanceAccount":{"$ref":"#/definitions/RecordRef"},"openingBalanceDate":{"format":"date","type":"string"},"password":{"type":"string"},"password2":{"type":"string"},"payablesAccount":{"$ref":"#/definitions/RecordRef"},"phone":{"type":"string"},"phoneticName":{"type":"string"},"pricingScheduleList":{"$ref":"#/definitions/VendorPricingScheduleList"},"printOnCheckAs":{"type":"string"},"printTransactions":{"type":"boolean"},"purchaseOrderAmount":{"type":"number"},"purchaseOrderQuantity":{"type":"number"},"purchaseOrderQuantityDiff":{"type":"number"},"receiptAmount":{"type":"number"},"receiptQuantity":{"type":"number"},"receiptQuantityDiff":{"type":"number"},"representingSubsidiary":{"$ref":"#/definitions/RecordRef"},"requirePwdChange":{"type":"boolean"},"rolesList":{"$ref":"#/definitions/VendorRolesList"},"salutation":{"type":"string"},"sendEmail":{"type":"boolean"},"subscriptionsList":{"$ref":"#/definitions/SubscriptionsList"},"subsidiary":{"$ref":"#/definitions/RecordRef"},"taxIdNum":{"type":"string"},"taxItem":{"$ref":"#/definitions/RecordRef"},"terms":{"$ref":"#/definitions/RecordRef"},"title":{"type":"string"},"unbilledOrders":{"type":"number"},"unbilledOrdersPrimary":{"type":"number"},"url":{"type":"string"},"vatRegNumber":{"type":"string"},"workCalendar":{"$ref":"#/definitions/RecordRef"}},"type":"object"},"BulkObject":{"properties":{"":{"type":"string"}},"type":"object"},"Class":{"properties":{"createdDate":{"format":"date-time","type":"string"},"id":{"type":"string"},"name":{"type":"string"},"updatedDate":{"format":"date-time","type":"string"}},"type":"object"},"CreditTerm":{"properties":{"createdDate":{"format":"date-time","type":"string"},"id":{"type":"string"},"name":{"type":"string"},"updatedDate":{"format":"date-time","type":"string"}},"type":"object"},"Customer":{"properties":{"address":{"items":{"$ref":"#/definitions/Address"},"type":"array"},"email":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"}},"required":["email"],"type":"object"},"Invoice":{"properties":{"createdDate":{"format":"date-time","type":"string"},"customerId":{"type":"string"},"dueDate":{"format":"date-time","type":"string"},"emailAddress":{"type":"string"},"id":{"type":"string"},"line":{"items":{"$ref":"#/definitions/InvoiceLineItem"},"type":"array"},"referenceId":{"type":"string"},"salesTermId":{"type":"string"},"shippingDate":{"type":"string"},"totalAmount":{"format":"float","type":"number"},"transactionDate":{"format":"date-time","type":"string"},"updatedDate":{"format":"date-time","type":"string"},"version":{"type":"string"}},"type":"object"},"InvoiceLineItem":{"properties":{"billable":{"type":"boolean"},"classId":{"type":"string"},"customerId":{"type":"string"},"description":{"type":"string"},"id":{"type":"string"},"lineType":{"enum":["Sales","Description"],"type":"string"},"productId":{"type":"string"},"quantity":{"type":"integer"},"taxCodeId":{"type":"string"},"unitPrice":{"format":"float","type":"number"}},"type":"object"},"JournalEntry":{"properties":{"adjustment":{"type":"boolean"},"createdDate":{"format":"date-time","type":"string"},"id":{"type":"string"},"line":{"items":{"$ref":"#/definitions/JournalEntryLine"},"type":"array"},"totalAmt":{"format":"float","type":"number"},"txnDate":{"type":"string"},"updatedDate":{"format":"date-time","type":"string"}},"type":"object"},"JournalEntryLineDetail":{"properties":{"accountId":{"type":"string"},"billableStatus":{"type":"string"},"classId":{"type":"string"},"departmentId":{"type":"string"},"postingType":{"type":"string"}},"type":"object"},"LedgerAccount":{"properties":{"createdDate":{"format":"date-time","type":"string"},"id":{"type":"string"},"name":{"type":"string"},"updatedDate":{"format":"date-time","type":"string"}},"type":"object"},"Payment":{"properties":{"amount":{"type":"string"},"kind":{"type":"string"}},"type":"object"},"PaymentLineItem":{"properties":{"amount":{"format":"float","type":"number"},"transactionId":{"type":"string"},"transactionType":{"type":"string"}},"type":"object"},"PaymentMethod":{"properties":{"createdDate":{"format":"date-time","type":"string"},"id":{"type":"string"},"name":{"type":"string"},"updatedDate":{"format":"date-time","type":"string"}},"type":"object"},"PurchaseOrder":{"description":"A Purchase Order object. With the exception of the 'id' field, the required fields indicated are those required to create a new contact. For other contact operations, the required fields will be a subset of these fields. There will be other fields returned with a Purchase Order, which are not all described here.","properties":{"accountId":{"type":"string"},"createdDate":{"format":"date-time","type":"string"},"id":{"type":"string"},"line":{"items":{"$ref":"#/definitions/InvoiceLineItem"},"type":"array"},"referenceId":{"type":"string"},"shippingAddress":{"$ref":"#/definitions/Address"},"status":{"type":"string"},"totalAmount":{"format":"float","type":"number"},"transactionDate":{"format":"date-time","type":"string"},"updatedDate":{"format":"date-time","type":"string"},"vendorAddress":{"$ref":"#/definitions/Address"},"vendorId":{"type":"string"}},"required":["accountId","vendorId","line"],"type":"object"},"PurchaseOrderLineItem":{"properties":{"accountId":{"type":"string"},"billable":{"type":"boolean"},"classId":{"type":"string"},"customerId":{"type":"string"},"description":{"type":"string"},"id":{"type":"string"},"lineType":{"enum":["Account","Expense"],"type":"string"},"productId":{"type":"string"},"quantity":{"type":"integer"},"taxCodeId":{"type":"string"},"unitPrice":{"format":"float","type":"number"}},"type":"object"},"Report":{},"ReportMetadata":{"properties":{"id":{"type":"string"}},"type":"object"},"TaxCode":{"properties":{"createdDate":{"format":"date-time","type":"string"},"id":{"type":"string"},"name":{"type":"string"},"updatedDate":{"format":"date-time","type":"string"}},"type":"object"},"TaxRate":{"properties":{"createdDate":{"format":"date-time","type":"string"},"id":{"type":"string"},"name":{"type":"string"},"taxRate":{"format":"float","type":"number"},"updatedDate":{"format":"date-time","type":"string"}},"type":"object"},"TimeActivity":{"properties":{"billableStatus":{"enum":["BILLABLE","NOT_BILLABLE"],"type":"string"},"breakHours":{"maximum":8760,"minimum":0,"type":"integer"},"breakMinutes":{"maximum":59,"minimum":0,"type":"integer"},"classRef":{"$ref":"#/definitions/CodeRef"},"customerRef":{"$ref":"#/definitions/CodeRef"},"departmentRef":{"$ref":"#/definitions/CodeRef"},"description":{"type":"string"},"employeeRef":{"$ref":"#/definitions/CodeRef","description":"required if nameOf = EMPLOYEE"},"endTime":{"format":"date-time","type":"string"},"hourlyRate":{"format":"float","type":"number"},"hours":{"maximum":8760,"minimum":0,"type":"integer"},"itemRef":{"$ref":"#/definitions/CodeRef"},"minutes":{"maximum":59,"minimum":0,"type":"integer"},"nameOf":{"enum":["EMPLOYEE","VENDOR"],"type":"string"},"startTime":{"format":"date-time","type":"string"},"taxable":{"type":"boolean"},"timeZone":{"type":"string"},"txnDate":{"format":"date","type":"string"},"vendorRef":{"$ref":"#/definitions/CodeRef","description":"required if nameOf = VENDOR"}},"required":["nameOf","employeeRef","vendorRef"],"type":"object"},"Vendor":{"description":"A Vendor object. With the exception of the 'id' field, the required fields indicated are those required to create a new contact. For other contact operations, the required fields will be a subset of these fields. There will be other fields returned with a Vendor, which are not all described here.","properties":{"accountNumber":{"type":"string"},"active":{"type":"boolean"},"balance":{"format":"float","type":"number"},"billingAddress":{"$ref":"#/definitions/Address"},"companyName":{"type":"string"},"createdDate":{"format":"date-time","type":"string"},"description":{"type":"string"},"emailAddress":{"type":"string"},"fax":{"type":"string"},"firstName":{"type":"string"},"id":{"type":"string"},"is1099":{"type":"boolean"},"lastName":{"type":"string"},"middleName":{"type":"string"},"nationalId":{"type":"string"},"primaryPhone":{"type":"string"},"suffix":{"type":"string"},"termId":{"type":"string"},"title":{"type":"string"},"updatedDate":{"format":"date-time","type":"string"},"version":{"type":"string"}},"required":["firstName","lastName","companyName"],"type":"object"},"Attachment":{"properties":{"contentType":{"type":"string"},"contentUrl":{"type":"string"},"fileName":{"type":"string"},"fileSize":{"type":"string"},"id":{"type":"string"},"referenceToken":{"type":"string"},"thumbnails":{"type":"string"},"url":{"type":"string"}},"type":"object"},"AttachmentConfig":{"properties":{"publish":{"format":"int32","type":"integer"}},"type":"object"},"Comments":{"properties":{"body":{"type":"string"},"id":{"type":"string"},"noteType":{"type":"string"},"publish":{"format":"int32","type":"integer"},"title":{"type":"string"}},"type":"object"},"History":{"properties":{"createdDate":{"format":"date","type":"string"},"data":{"type":"string"},"id":{"type":"string"},"incidentId":{"type":"string"}},"type":"object"},"Incident":{"properties":{"assignee":{"type":"string"},"description":{"type":"string"},"id":{"type":"string"},"reporter":{"type":"string"},"status":{"type":"string"},"subject":{"type":"string"},"summary":{"type":"string"},"type":{"type":"string"}},"type":"object"},"IncidentType":{"properties":{"description":{"type":"string"},"id":{"type":"string"},"position":{"type":"string"},"required":{"type":"boolean"},"title":{"type":"string"},"type":{"type":"string"}},"type":"object"},"Priority":{"properties":{"description":{"type":"string"},"id":{"type":"string"},"position":{"type":"string"},"required":{"type":"boolean"},"title":{"type":"string"},"type":{"type":"string"}},"type":"object"},"Status":{"properties":{"description":{"type":"string"},"id":{"type":"string"},"position":{"type":"string"},"required":{"type":"boolean"},"title":{"type":"string"},"type":{"type":"string"}},"type":"object"},"Activity":{"properties":{"created_at":{"type":"string"},"id":{"type":"number"},"type":{"type":"number"},"type_name":{"type":"string"}},"type":"object"},"Campaign":{"description":"A campaign object. With the exception of the 'id' field, the required fields indicated are those required to create a new campaign. For other campaign operations, the required fields will be a subset of these fields. There will be other fields returned with a Campaign, which are not all described here.","properties":{"description":{"type":"string"},"endDate":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"startDate":{"type":"string"},"status":{"type":"string"},"type":{"type":"string"}},"required":["name"],"type":"object"},"CampaignContact":{"description":"A contact object in a campaign.","properties":{"campaignStatus":{"description":"The status of the contact within the campaign. The allowable values are 'Sent' or 'Responded'","type":"string"},"id":{"type":"string"}},"required":["id","campaignStatus"],"type":"object"},"CampaignLead":{"description":"A lead object in a campaign.","properties":{"campaignStatus":{"description":"The status of the lead within the campaign. The allowable values are 'Sent' or 'Responded'","type":"string"},"id":{"type":"string"}},"required":["id","campaignStatus"],"type":"object"},"MessagingRequest":{"properties":{"bcc":{"type":"string"},"cc":{"type":"string"},"clickTrack":{"type":"boolean"},"createdDate":{"type":"string"},"direction":{"type":"string"},"externalMessageId":{"type":"string"},"from":{"type":"string"},"id":{"format":"int32","type":"integer"},"message":{"type":"string"},"mimeType":{"type":"string"},"openTrack":{"type":"boolean"},"priority":{"type":"string"},"providerName":{"type":"string"},"received":{"type":"boolean"},"receivedDate":{"type":"string"},"refId":{"type":"string"},"sent":{"type":"boolean"},"sentTime":{"type":"string"},"status":{"type":"string"},"subject":{"type":"string"},"to":{"type":"string"},"updateDate":{"type":"string"}},"required":["message","to"],"type":"object"},"MessagingUsage":{"properties":{"count":{"format":"int32","type":"integer"},"endDate":{"type":"string"},"startDate":{"type":"string"}},"type":"object"},"caption":{"properties":{"created_time":{"type":"string"},"from":{"$ref":"#/definitions/from"},"id":{"type":"string"},"text":{"type":"string"}},"type":"object"},"comments":{"properties":{"count":{"format":"int32","type":"integer"}},"type":"object"},"counts":{"properties":{"followed_by":{"format":"int32","type":"integer"},"follows":{"format":"int32","type":"integer"},"media":{"format":"int32","type":"integer"}},"type":"object"},"data":{"properties":{"full_name":{"type":"string"},"id":{"type":"string"},"profile_picture":{"type":"string"},"username":{"type":"string"}},"type":"object"},"from":{"properties":{"full_name":{"type":"string"},"id":{"type":"string"},"profile_picture":{"type":"string"},"username":{"type":"string"}},"type":"object"},"images":{"properties":{"low_resolution":{"$ref":"#/definitions/low_resolution"},"standard_resolution":{"$ref":"#/definitions/standard_resolution"},"thumbnail":{"$ref":"#/definitions/thumbnail"}},"type":"object"},"likes":{"properties":{"count":{"format":"int32","type":"integer"},"data":{"items":{"$ref":"#/definitions/data"},"type":"array"}},"type":"object"},"location":{"properties":{"id":{"format":"int32","type":"integer"},"latitude":{"format":"double","type":"number"},"longitude":{"format":"double","type":"number"},"name":{"type":"string"}},"type":"object"},"low_resolution":{"properties":{"height":{"format":"int32","type":"integer"},"url":{"type":"string"},"width":{"format":"int32","type":"integer"}},"type":"object"},"media":{"properties":{"caption":{"$ref":"#/definitions/caption"},"comments":{"$ref":"#/definitions/comments"},"created_time":{"type":"string"},"filter":{"type":"string"},"id":{"type":"string"},"images":{"$ref":"#/definitions/images"},"likes":{"$ref":"#/definitions/likes"},"link":{"type":"string"},"location":{"$ref":"#/definitions/location"},"type":{"type":"string"},"user":{"$ref":"#/definitions/user"},"user_has_liked":{"type":"boolean"},"users_in_photo":{"items":{"$ref":"#/definitions/users_in_photo"},"type":"array"}},"type":"object"},"position":{"properties":{"x":{"format":"double","type":"number"},"y":{"format":"double","type":"number"}},"type":"object"},"standard_resolution":{"properties":{"height":{"format":"int32","type":"integer"},"url":{"type":"string"},"width":{"format":"int32","type":"integer"}},"type":"object"},"thumbnail":{"properties":{"height":{"format":"int32","type":"integer"},"url":{"type":"string"},"width":{"format":"int32","type":"integer"}},"type":"object"},"user":{"properties":{"full_name":{"type":"string"},"id":{"type":"string"},"profile_picture":{"type":"string"},"username":{"type":"string"}},"type":"object"},"users":{"properties":{"bio":{"type":"string"},"counts":{"$ref":"#/definitions/counts"},"full_name":{"type":"string"},"id":{"type":"string"},"profile_picture":{"type":"string"},"username":{"type":"string"},"website":{"type":"string"}},"type":"object"},"usersList":{"properties":{"full_name":{"type":"string"},"id":{"type":"string"},"profile_picture":{"type":"string"},"username":{"type":"string"}},"type":"object"},"users_in_photo":{"properties":{"position":{"$ref":"#/definitions/position"},"user":{"$ref":"#/definitions/user"}},"type":"object"},"Link":{"properties":{"href":{"type":"string"}},"type":"object"},"Order":{"properties":{"email":{"type":"string"},"fulfillment_status":{"type":"string"},"total_price":{"type":"string"}},"type":"object"},"bccEmailAddresses":{"properties":{"email":{"type":"string"}},"type":"object"},"documents":{"properties":{"documentId":{"type":"string"},"name":{"type":"string"},"order":{"type":"string"},"pages":{"type":"string"},"type":{"type":"string"},"uri":{"type":"string"}},"type":"object"},"emailSettings":{"properties":{"bccEmailAddresses":{"items":{"$ref":"#/definitions/bccEmailAddresses"},"type":"array"},"replyEmailAddressOverride":{"type":"string"},"replyEmailNameOverride":{"type":"string"}},"type":"object"},"envelopeEvents":{"properties":{"envelopeEventStatus":{"type":"string"}},"type":"object"},"envelopes":{"properties":{"allowMarkup":{"type":"boolean"},"allowReassign":{"type":"boolean"},"allowRecipientRecursion":{"type":"boolean"},"asynchronous":{"type":"boolean"},"authoritativeCopy":{"type":"boolean"},"autoNavigation":{"type":"boolean"},"documents":{"items":{"$ref":"#/definitions/documents"},"type":"array"},"emailBlurb":{"type":"string"},"emailSettings":{"$ref":"#/definitions/emailSettings"},"emailSubject":{"type":"string"},"enableWetSign":{"type":"boolean"},"enforceSignerVisibility":{"type":"boolean"},"envelopeIdStamping":{"type":"boolean"},"eventNotification":{"$ref":"#/definitions/eventNotification"},"messageLock":{"type":"boolean"},"notification":{"$ref":"#/definitions/notification"},"recipients":{"$ref":"#/definitions/recipients"},"recipientsLock":{"type":"boolean"},"signingLocation":{"type":"string"},"status":{"description":"sent or created","type":"string"},"useDisclosure":{"type":"boolean"}},"type":"object"},"envelopesList":{"items":{"$ref":"#/definitions/envelopesListObject"},"type":"array"},"envelopesListObject":{"properties":{"certificateUri":{"type":"string"},"customFieldsUri":{"type":"string"},"documentsCombinedUri":{"type":"string"},"documentsUri":{"type":"string"},"envelopeId":{"type":"string"},"envelopeUri":{"type":"string"},"notificationUri":{"type":"string"},"recipientsUri":{"type":"string"},"status":{"type":"string"},"statusChangedDateTime":{"type":"string"},"templatesUri":{"type":"string"}},"type":"object"},"eventNotification":{"properties":{"envelopeEvents":{"items":{"$ref":"#/definitions/envelopeEvents"},"type":"array"},"includeCertificateOfCompletion":{"type":"boolean"},"includeCertificateWithSoap":{"type":"boolean"},"includeDocumentFields":{"type":"boolean"},"includeDocuments":{"type":"boolean"},"includeSenderAccountAsCustomField":{"type":"boolean"},"includeTimeZone":{"type":"boolean"},"includeenvelopesVoidReason":{"type":"boolean"},"loggingEnabled":{"type":"boolean"},"recipientEvents":{"items":{"$ref":"#/definitions/recipientEvents"},"type":"array"},"requireAcknowledgment":{"type":"boolean"},"signMessageWithX509Cert":{"type":"boolean"},"url":{"type":"string"},"useSoapInterface":{"type":"boolean"}},"type":"object"},"expirations":{"properties":{"expireAfter":{"format":"int32","type":"integer"},"expireEnabled":{"type":"boolean"},"expireWarn":{"format":"int32","type":"integer"}},"type":"object"},"notification":{"properties":{"expirations":{"$ref":"#/definitions/expirations"},"reminders":{"$ref":"#/definitions/reminders"},"useAccountDefaults":{"type":"boolean"}},"type":"object"},"recipientEvents":{"properties":{"recipientEventStatus":{"type":"string"}},"type":"object"},"recipients":{"properties":{"signers":{"items":{"$ref":"#/definitions/signers"},"type":"array"}},"type":"object"},"reminders":{"properties":{"reminderDelay":{"type":"string"},"reminderEnabled":{"type":"boolean"},"reminderFrequency":{"type":"string"}},"type":"object"},"signHereTabs":{"properties":{"anchorString":{"type":"string"},"name":{"type":"string"}},"type":"object"},"signers":{"properties":{"email":{"type":"string"},"name":{"type":"string"},"recipientId":{"type":"string"}},"type":"object"},"tabs":{"properties":{"signHereTabs":{"items":{"$ref":"#/definitions/signHereTabs"},"type":"array"}},"type":"object"}},"swagger":"2.0","info":{"contact":{"email":"support@cloud-elements.com"},"title":"Elements","version":"api-v2"},"tags":[{"description":"The Elements APIs","name":"elements"},{"description":"The Element Builder API","name":"elementsbuilder"},{"description":"The Instance APIs","name":"instances"},{"description":"The Customers APIs","name":"customers"},{"description":"The Organizations APIs","name":"organizations"},{"description":"The Accounts APIs","name":"accounts"},{"description":"The Users APIs","name":"users"},{"description":"The Hubs APIs","name":"hubs"},{"description":"The Metrics APIs","name":"metrics"},{"description":"The Usage APIs","name":"usage"},{"description":"The Formula APIs","name":"formulas"},{"name":"jobs","description":"jobs Element"},{"description":"The Audit Logs APIs","name":"audit-logs"},{"description":"The Document hub APIs","name":"documents"},{"description":"The CRM hub APIs","name":"crm"},{"description":"The ERP hub APIs","name":"erp"},{"description":"The Finance hub APIs","name":"finance"},{"description":"The Helpdesk hub APIs","name":"helpdesk"},{"description":"The Humancapital hub APIs","name":"humancapital"},{"description":"The Marketing hub APIs","name":"marketing"},{"description":"The Messaging hub APIs","name":"messaging"},{"description":"The Social hub APIs","name":"social"},{"description":"The idManagement hub APIs","name":"idmanagement"},{"description":"The eCommerce hub APIs","name":"ecommerce"},{"description":"The eSignature hub APIs","name":"esignature"}]}