Exportations
Chaque opération de ce groupe : ce qu'elle accepte, ce qu'elle retourne et les erreurs qu'elle peut renvoyer.
Opérations
A zip of the whole workspace, as the Export page of the app makes it: every conversation as mbox files with its attachments, contacts as vCard, audiences, calendar events as .ics, templates with every version, rules, labels, notes and addresses. An export is made in the background, can be started once a day and is kept for 365 days.
Only the workspace owner, or a member whose role holds every permission, can export the workspace: an API key, or an app connected with every address. A key or an app limited to particular addresses or domains is a 422 capability_unsupported, and an account the workspace cannot export for is a 403 export_not_permitted.
GET/exports/preview
See what an export would hold
Whether this workspace can be exported by the caller now, when the next export can start, the export still being made, if there is one, and how much an export would hold. When allowed is false, reason says why and counts is null.
Only the workspace owner, or a member whose role holds every permission, can export the workspace: an API key, or an app connected with every address. A key or an app limited to particular addresses or domains is a 422 capability_unsupported, and an account the workspace cannot export for is a 403 export_not_permitted.
Requires the threads:read scope.
Retourne
What an export would hold, and whether one can start.
Erreurs
Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs
Aussi disponible dans
GET/exports
List the exports
Every export of the workspace, newest first, with its status and progress. limit and offset page through them, and total counts them all.
Only the workspace owner, or a member whose role holds every permission, can export the workspace: an API key, or an app connected with every address. A key or an app limited to particular addresses or domains is a 422 capability_unsupported, and an account the workspace cannot export for is a 403 export_not_permitted.
Requires the threads:read scope.
Paramètres de requête
limitintegerExports per page, 1 to 100.
Au moins 1Au plus 100Par défaut25offsetintegerHow many exports to skip.
Au moins 0Par défaut0
Retourne
A page of exports, newest first.
Erreurs
Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs
Aussi disponible dans
POST/exports
Start an export
Starts making a zip of the whole workspace, as Export now on the Export page does. It is made in the background: read it with GET /exports/{id} until status is ready, then download it. One export can run at a time, and a workspace can be exported once a day.
Only the workspace owner, or a member whose role holds every permission, can export the workspace: an API key, or an app connected with every address. A key or an app limited to particular addresses or domains is a 422 capability_unsupported, and an account the workspace cannot export for is a 403 export_not_permitted.
Requires the threads:read scope.
Retourne
The export, queued.
Erreurs
- 403
The key lacks the scope, or may not send as that address.
step_up_required: the call was made with an OAuth access token that has not been verified in the last 60 minutes. Ask for a code withPOST /security/step-up, send it toPOST /security/step-up/verify, then repeat the call. The person can also choose Allow changes for 60 minutes on the app in Account settings, Connected apps, on the OpenEmail website. An API key is never asked for a code.- 409
already_running: an export of this workspace is already being made.- 429
export_limit_reached: the workspace was exported in the last day.
Les erreurs que toute opération peut renvoyer400401404422500Catalogue des erreurs
Aussi disponible dans
GET/exports/{id}
Retrieve an export
One export, with its status, its progress through the conversations and, once it is ready, its size, file name and when it is deleted.
Only the workspace owner, or a member whose role holds every permission, can export the workspace: an API key, or an app connected with every address. A key or an app limited to particular addresses or domains is a 422 capability_unsupported, and an account the workspace cannot export for is a 403 export_not_permitted.
Requires the threads:read scope.
Paramètres de chemin
idstringObligatoireThe export id from
GET /exportsorPOST /exports.
Retourne
The export.
Erreurs
Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs
Aussi disponible dans
GET/exports/{id}/content
Download an export
The zip itself, as application/zip with its file name in Content-Disposition. It is only there once the export is ready: before that the call is a 409 export_not_ready, and an export older than 365 days is a 409 expired.
Only the workspace owner, or a member whose role holds every permission, can export the workspace: an API key, or an app connected with every address. A key or an app limited to particular addresses or domains is a 422 capability_unsupported, and an account the workspace cannot export for is a 403 export_not_permitted.
Requires the threads:read scope.
Paramètres de chemin
idstringObligatoireThe export id from
GET /exportsorPOST /exports.
Retourne
application/zipThe zip.
Erreurs
- 403
The key lacks the scope, or may not send as that address.
step_up_required: the call was made with an OAuth access token that has not been verified in the last 60 minutes. Ask for a code withPOST /security/step-up, send it toPOST /security/step-up/verify, then repeat the call. The person can also choose Allow changes for 60 minutes on the app in Account settings, Connected apps, on the OpenEmail website. An API key is never asked for a code.- 409
export_not_ready: the export is still being made or failed.expired: it was deleted a year after it was made.
Les erreurs que toute opération peut renvoyer400401404422500Catalogue des erreurs
Aussi disponible dans
Objets
Exportobject
objectstringObligatoire- L'un de
"export" idstringObligatoirestatusstringObligatoire- L'un de
"queued""running""ready""failed""expired" phasestringWhat it is doing while
statusisrunning.Peut être nullL'un de"planning""mail""records""finishing"createdAtstringObligatoire- Format
date-time createdByobjectWho started it, or null when that account is gone.
Peut être nullnamestring- Peut être null
emailstring
startedAtstring- Peut être nullFormat
date-time finishedAtstring- Peut être nullFormat
date-time expiresAtstringWhen the zip is deleted, a year after it was made.
Peut être nullFormatdate-timesizeBytesinteger- Peut être null
fileNamestring- Peut être null
threadsDoneinteger- Au moins 0
threadsTotalinteger- Peut être null
errorstringWhy it failed, when
statusisfailed.Peut être null
ExportListobject
objectstring- L'un de
"list" dataExport[]totalintegerHow many exports there are in all.
Au moins 0hasMorebooleanWhether more exports follow this page.
ExportPreviewobject
objectstringObligatoire- L'un de
"export_preview" allowedbooleanObligatoireWhether the caller may export this workspace.
reasonstringObligatoireWhy not, when
allowedis false:not-permittedfor an account that is neither the owner nor holds every permission,mailbox-loginfor a sign-in for one address, andtwo-factor-requiredwhen the workspace requires two-factor sign-in and the account has none.Peut être nullL'un de"not-permitted""mailbox-login""two-factor-required"nextAvailableAtstringObligatoireWhen the next export can start, or null when one can start now.
Peut être nullFormatdate-timeactiveExportIdstringObligatoireThe export still being made, if there is one.
Peut être nullcountsobjectObligatoireHow much an export would hold now. Null when
allowedis false.Peut être nullthreadsintegerConversations.
Au moins 0attachmentsintegerAttachments inside them.
Au moins 0attachmentBytesintegerThe size of those attachments, in bytes.
Au moins 0deletedFilesintegerDeleted files, listed by name and date but not included.
Au moins 0contactsintegerContacts.
Au moins 0audiencesintegerAudiences.
Au moins 0calendarEventsintegerCalendar events.
Au moins 0templatesintegerTemplates.
Au moins 0rulesintegerRules.
Au moins 0labelsintegerLabels.
Au moins 0notesintegerNotes of the caller.
Au moins 0addressesintegerAddresses.
Au moins 0