Download integrator.io Postman collection
Contents
Export API endpoints
Relative URI | Method | Success code | Description |
/exports | GET | 200 | Get all exports. |
POST | 201 | Create an export. | |
/exports/<_id> | GET | 200 | Get a specific export. |
PUT | 200 | Update a specific export. | |
DELETE | 204 | Delete a specific export. | |
/exports/<_id>/distributed | GET | 200 | Get the distributed configuration (the fields stored directly in the export application). This API is currently needed only for Salesforce and NetSuite real-time exports. |
PUT | 200 | Update the distributed configuration for a specific export. This API is currently needed for only Salesforce and NetSuite real-time exports. | |
/exports/<_id>/clone | POST | 201 | Clone a specific export. |
/exports/<_id>/audit | GET | 200 | Get a log for a specific export. |
/exports/<_id>/invoke | POST | 200 | Invoke an export. Data and settings can be passed in the request body to invoke the export. |
Export API examples
GET /v1/exports/55e••••••••••••••••••366 HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token
Sample response
{ "_id":"55e••••••••••••••••••366", "lastModified":"2017-04-16T18:56:15.879Z", "name":"GitHub Event Listener", "type":"webhook", "hooks":{ "preSavePage":{ "_stackId":null, "function":null } }, "webhook":{ "provider":"github", "key":"••••••" } }
PUT /v1/exports/55e••••••••••••••••••366 HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token
{ "_id":"55e••••••••••••••••••366", "lastModified":"2017-04-16T18:56:15.879Z", "name":"GitHub Event Listener (updated!)", "type":"webhook", "hooks":{ "preSavePage":{ "_stackId":null, "function":null } }, "webhook":{ "provider":"github", "key":"••••••" } }
Sample response
{ "_id":"55e••••••••••••••••••366", "lastModified":"2017-11-28T19:37:04.180Z", "name":"GitHub Event Listener (updated!)", "type":"webhook", "webhook":{ "provider":"github", "key":"•••••" } }
POST /v1/exports/55e••••••••••••••••••366/invoke HTTP/1.1 Host: api.integrator.io Authorization: Bearer my_api_token
Sample response
"{ "data": [ { "id": "100", ""recordType"": ""account"", "Name": "Telephone Expense : Online Fees", "Display Name": "6268 Telephone Expense : Online Fees", "Account Type": "Expense", "Description": ", "Balance": "9000.00", "Show in Fixed Assets Management": ""Depreciation Expense,Disposal Cost Account,Write Down Account,Write Off Account" }, { "id": "101", ""recordType"": ""account"", "Name"": "Utilities"", "Display Name": ""6300 Utilities", "Account Type": ""Expense", "Description"": ", "Balance"": ".00"", "Show in Fixed Assets Management": ""Depreciation Expense,Disposal Cost Account,Write Down Account,Write Off Account" } ], }"
Pass data and settings
If you want to pass settings along with data in an export, you must wrap the details in individual data and settings JSON objects.
If you’re using a handlebar format other than those mentioned in exports.run( options ) document, the correct format to send both data and settings is shown in the below screenshots.
Comments
0 comments
Please sign in to leave a comment.