Export API endpoints

Kathyana Queeman

Updated December 04, 2024 15:10

Export API endpoints

Relative URI	Method	Success code	Description
`/exports`	`GET`	`200`	Get all exports.
`/exports`	`POST`	`201`	Create an export.
`/exports/<_id>`	`GET`	`200`	Get a specific export.
	`PUT`	`200`	Update a specific export.
	`PATCH`	`204`	Update part of 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.
`/exports/<_id>/distributed`	`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.
`/exports/<_id>/replaceConnection`	`PUT`	`200`	Replace a connection in an export.
`/exports/<_id>/dependencies`	`GET`	`200`	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
`assistantMetadata`	`mixed`
`netsuite.distributed.disabled`	`boolean`
`salesforce.distributed.disabled`	`boolean`
`debugUntil`	`date`

Export API examples

Get a specific export

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":"••••••"
  }
}

Update the name field for an export

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":"•••••"
  }
}

Invoke an export

    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.

Screenshot 2023-07-19 at 2.31.59 PM (1).png

Comments

2 comments

Chris Huovinen
July 08, 2024 22:00

Should this link above take me to another page or download a document? It doesn't respond when I click it. I'm looking for more details on how to update an export via the API.
exports.run( options )

0
Kathyana Queeman
July 09, 2024 13:41

Technical Writer

Hi Chris Huovinen,

Here's the correct link! Thanks for your patience: exports.run( options )

0

Please sign in to leave a comment.