Find us at our new Help Center where we've combined our documentation and knowledgebase articles in one easy-to-search location.
We aren't updating the Developer Portal anymore, except for the Element Docs — all updates happen in the Help Center. We're retiring the Developer Portal as you know it in:
Use bulk download to generate a csv or json file from a large number of records. Since the bulk download works asynchronously, you need to make two calls to download a file.
The POST /bulk/query creates a bulk job, which builds out a file in Cloud Elements. Use a CEQL query to specify the records included in the file. Since the job will take an unknown amount of time to complete, add a callback url to the bulk job. When the job completes it will make a callback to the url.
The bulk query API call is composed of the following parts:
Elements-Async-Callback-Url: The webhook to be notified when a job completes. If you configured the Callback Notification Signature Key (event.notification.signature.key) when you authenticated an element instance, the bulk APIs will use the signature key to provide hash verification in the header of bulk jobs. For more on Cloud Elements Hash Verification, see Event Management: Securityq : A CEQL query for records to be included in the bulk job, for example: select * from contacts.After the job generated from the /bulk/query call completes, use GET /bulk/{id}/{objectName} to download the file. The file can be downloaded as a csv or json file.
Accept: The format of the file to download, either text/csv or application/json.{id}: The bulk job id generated by POST /bulk/query.{objectName}: The object name that was used to generate the bulk query.