Pular para o conteúdo
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Export

Get backups available for export

get

Returns terminal backups and archives that can be selected as an export source. Backups that are still in progress are excluded.

Autorizações
AuthorizationstringObrigatório

Bearer <access_token>

Parâmetros de rota
connectionIdnumberObrigatório
Parâmetros de consulta
searchstringOpcional

Search term (max 80)

pagenumberObrigatório

Number of page (min 1)

Example: 1
limitnumberObrigatório

Limit of entities per page (min 1, max 2000)

Example: 50
sortBystring · enumOpcionalExample: jobIdValores possíveis:
orderstring · enumOpcionalExample: DESCValores possíveis:
Respostas
200

Backups available as export sources

application/json
totalnumberObrigatório

Total number of entities.

Example: 1
get/api/v1/connections/{connectionId}/exports/backups
GET /api/v1/connections/{connectionId}/exports/backups?page=1&limit=50&types=full HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "total": 1,
  "items": [
    {
      "id": 1,
      "name": "My backup",
      "jobId": 1,
      "jobStatus": "Completed",
      "startedDate": "2026-01-01T00:00:00.000Z",
      "duration": "text",
      "size": 1,
      "records": 1,
      "operationType": "Composite Backup"
    }
  ]
}

Get objects available for export from selected backup

get

Returns the objects and record totals stored in the selected backup. Use an object name from this response as steps[].objectApiName when creating an export.

Autorizações
AuthorizationstringObrigatório

Bearer <access_token>

Parâmetros de rota
connectionIdnumberObrigatório
backupIdnumberObrigatório

Backup or archive identifier

Parâmetros de consulta
searchstringOpcional

Search term (max 80)

pagenumberObrigatório

Number of page (min 1)

Example: 1
limitnumberObrigatório

Limit of entities per page (min 1, max 2000)

Example: 50
sortBystringOpcionalExample: name
orderstring · enumOpcionalExample: DESCValores possíveis:
aiModifiedOnlybooleanOpcionalDefault: false
Respostas
200

Objects available in the selected backup

application/json
totalnumberObrigatório

Total number of entities.

Example: 1
get/api/v1/connections/{connectionId}/exports/backups/{backupId}/objects
GET /api/v1/connections/{connectionId}/exports/backups/{backupId}/objects?page=1&limit=50 HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "totalData": {
    "name": "Total",
    "totalRecords": 1
  },
  "total": 1,
  "items": [
    {
      "name": "text",
      "totalRecords": 1,
      "addedRecordVersions": 1,
      "changedRecordVersions": 1,
      "deletedRecordVersions": 1,
      "size": 1
    }
  ]
}

Create export from selected backup

post

Starts an asynchronous export for one or more objects from the selected backup and returns the job ID used to retrieve its status. For destination csv, the result is stored internally and can be downloaded when readyForDownload becomes true. For destination external-storage, storageId and path are required and the result is written directly to that storage. An object with no stored records can complete without generating a downloadable file. Object processing failures are reported asynchronously through the export status and public job logs.

Autorizações
AuthorizationstringObrigatório

Bearer <access_token>

Parâmetros de rota
connectionIdnumberObrigatório
backupIdnumberObrigatório

Backup or archive identifier

Corpo
destinationstring · enumObrigatório

Export destination: csv stores the result internally for later download; external-storage writes it to a configured storage.

Valores possíveis:
pathstringOpcional

Path prefix in the configured storage. Required for external-storage and not allowed for csv.

storageIdnumberOpcional

Configured storage identifier. Required for external-storage and not allowed for csv.

Respostas
201

Export job created

application/json
messagestringObrigatório
jobIdnumberObrigatório

Identifier used to retrieve the export status.

Example: 123
post/api/v1/connections/{connectionId}/exports/backups/{backupId}
POST /api/v1/connections/{connectionId}/exports/backups/{backupId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 212

{
  "steps": [
    {
      "objectApiName": "Account",
      "declarativeFilter": [
        {
          "value": "Test Name",
          "field": "Name",
          "option": "equals"
        }
      ],
      "declarativeFilterCustomLogic": "1 AND (2 OR 3)"
    }
  ],
  "destination": "csv",
  "path": "text",
  "storageId": 1
}
{
  "message": "text",
  "jobId": 123
}

Get available storages for export

get

Returns configured external storages. Pass the selected storage ID when destination is external-storage.

Autorizações
AuthorizationstringObrigatório

Bearer <access_token>

Parâmetros de rota
connectionIdnumberObrigatório
Parâmetros de consulta
searchstringOpcional

Search term (max 80)

pagenumberObrigatório

Number of page (min 1)

Example: 1
limitnumberObrigatório

Limit of entities per page (min 1, max 2000)

Example: 50
orderBystring · enumOpcional

Column to sort by

Default: idValores possíveis:
sortstring · enumOpcional

Sort direction

Default: DESCValores possíveis:
isDefaultbooleanOpcional

Filter by default storage flag. If true, returns only backup default storages. If false, returns only non-default.

Respostas
200

Configured external storages

application/json
totalnumberObrigatório

Total number of entities.

Example: 1
get/api/v1/connections/{connectionId}/exports/storages
GET /api/v1/connections/{connectionId}/exports/storages?page=1&limit=50 HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "total": 1,
  "items": [
    {
      "id": 1,
      "name": "text",
      "type": "Local"
    }
  ]
}

Get export status by job ID

get

Returns the current export status and destination. Poll while jobStatus is In Progress. For an internal csv export, download the result when readyForDownload is true. External-storage exports are never available through the internal download endpoint. For Exception or Aborted jobs, use the public job log endpoints to retrieve failure details.

Autorizações
AuthorizationstringObrigatório

Bearer <access_token>

Parâmetros de rota
connectionIdnumberObrigatório
jobIdnumberObrigatório

Export job identifier

Respostas
200

Export status and download readiness

application/json
jobIdnumberObrigatórioExample: 1
operationstringObrigatórioExample: Backup
exportTypestringObrigatórioExample: backup
asOfDatestring · date-time · anulávelObrigatório
fromDatestring · date-time · anulávelObrigatório
toDatestring · date-time · anulávelObrigatório
backupIdnumber · anulávelObrigatórioExample: 42
jobStatusstring · enumObrigatórioValores possíveis:
startedDatestring · date-timeObrigatório
durationstring · anulávelObrigatório
readyForDownloadbooleanObrigatório

True only when an internally stored export has completed and contains downloadable data.

Default: false
recordsSuccessCountnumber · anulávelObrigatório
endDatestring · date-time · anulávelObrigatório
pathstring · anulávelObrigatório

Configured path for external-storage exports; null for internal exports.

destinationstring · enumObrigatório

csv is internal storage; external-storage writes to a configured storage.

Valores possíveis:
get/api/v1/connections/{connectionId}/exports/{jobId}
GET /api/v1/connections/{connectionId}/exports/{jobId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "jobId": 1,
  "operation": "Backup",
  "exportType": "backup",
  "asOfDate": "2026-01-01T00:00:00.000Z",
  "fromDate": "2026-01-01T00:00:00.000Z",
  "toDate": "2026-01-01T00:00:00.000Z",
  "backupId": 42,
  "jobStatus": "In Progress",
  "startedDate": "2026-01-01T00:00:00.000Z",
  "duration": "text",
  "readyForDownload": false,
  "recordsSuccessCount": 1,
  "endDate": "2026-01-01T00:00:00.000Z",
  "path": "text",
  "destination": "csv"
}

Download an internally stored export

get

Downloads the generated ZIP for a csv export when its status response has readyForDownload set to true. External-storage exports cannot be downloaded through this endpoint.

Autorizações
AuthorizationstringObrigatório

Bearer <access_token>

Parâmetros de rota
connectionIdnumberObrigatório
jobIdnumberObrigatório

Export job identifier

Respostas
200

ZIP archive containing the exported CSV files

application/zip
string · binaryOpcional
get/api/v1/connections/{connectionId}/exports/{jobId}/download
GET /api/v1/connections/{connectionId}/exports/{jobId}/download HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
binary

Atualizado

Isto foi útil?