Download Postman collection
|
Relative URI |
Method |
Success code |
Description |
|---|---|---|---|
|
|
|
|
Get all exports. |
|
|
|
Create an export. |
|
|
|
|
|
Get a specific export. |
|
|
|
Update a specific export. |
|
|
|
|
Update part of a specific export. |
|
|
|
|
Delete a specific export. |
|
|
|
|
|
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. |
|
|
|
Update the distributed configuration for a specific export. This API is currently needed for only Salesforce and NetSuite real-time exports. |
|
|
|
|
|
Clone a specific export. |
|
|
|
|
Get a log for a specific export. |
|
|
|
|
Invoke an export. Data and settings can be passed in the request body to invoke the export. |
|
|
|
|
Replace a connection in an export. |
|
|
|
|
Get all resources using or used by this export. |
The following fields can be updated using PATCH. You must use the provided format to update the fields:
[
{
"op": "replace",
"path": "/fieldname",
"value": "newvalue"
}
]
|
Field |
Data type |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
GET /v1/exports/55e••••••••••••••••••366 HTTP/1.1 Host: api.integrator.io Authorization: Bearer my_api_token
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":"••••••"
}
}
POST /v1/exports/55e••••••••••••••••••366/invoke HTTP/1.1 Host: api.integrator.io Authorization: Bearer my_api_token
"{
"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"
}
],
}"
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.