Exportações
Cada operação deste grupo: o que aceita, o que devolve e os erros com que pode responder.
Operações
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.
Devolve
What an export would hold, and whether one can start.
Erros
Os erros que qualquer operação pode devolver400401403404422500Catálogo de erros
Também disponível em
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.
Parâmetros de consulta
limitintegerExports per page, 1 to 100.
Pelo menos 1No máximo 100Predefinição25offsetintegerHow many exports to skip.
Pelo menos 0Predefinição0
Devolve
A page of exports, newest first.
Erros
Os erros que qualquer operação pode devolver400401403404422500Catálogo de erros
Também disponível em
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.
Devolve
The export, queued.
Erros
- 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.
Os erros que qualquer operação pode devolver400401404422500Catálogo de erros
Também disponível em
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.
Parâmetros de caminho
idstringObrigatórioThe export id from
GET /exportsorPOST /exports.
Devolve
The export.
Erros
Os erros que qualquer operação pode devolver400401403404422500Catálogo de erros
Também disponível em
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.
Parâmetros de caminho
idstringObrigatórioThe export id from
GET /exportsorPOST /exports.
Devolve
application/zipThe zip.
Erros
- 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.
Os erros que qualquer operação pode devolver400401404422500Catálogo de erros
Também disponível em
Objetos
Exportobject
objectstringObrigatório- Um de
"export" idstringObrigatóriostatusstringObrigatório- Um de
"queued""running""ready""failed""expired" phasestringWhat it is doing while
statusisrunning.Pode ser nullUm de"planning""mail""records""finishing"createdAtstringObrigatório- Formato
date-time createdByobjectWho started it, or null when that account is gone.
Pode ser nullnamestring- Pode ser null
emailstring
startedAtstring- Pode ser nullFormato
date-time finishedAtstring- Pode ser nullFormato
date-time expiresAtstringWhen the zip is deleted, a year after it was made.
Pode ser nullFormatodate-timesizeBytesinteger- Pode ser null
fileNamestring- Pode ser null
threadsDoneinteger- Pelo menos 0
threadsTotalinteger- Pode ser null
errorstringWhy it failed, when
statusisfailed.Pode ser null
ExportListobject
objectstring- Um de
"list" dataExport[]totalintegerHow many exports there are in all.
Pelo menos 0hasMorebooleanWhether more exports follow this page.
ExportPreviewobject
objectstringObrigatório- Um de
"export_preview" allowedbooleanObrigatórioWhether the caller may export this workspace.
reasonstringObrigatórioWhy 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.Pode ser nullUm de"not-permitted""mailbox-login""two-factor-required"nextAvailableAtstringObrigatórioWhen the next export can start, or null when one can start now.
Pode ser nullFormatodate-timeactiveExportIdstringObrigatórioThe export still being made, if there is one.
Pode ser nullcountsobjectObrigatórioHow much an export would hold now. Null when
allowedis false.Pode ser nullthreadsintegerConversations.
Pelo menos 0attachmentsintegerAttachments inside them.
Pelo menos 0attachmentBytesintegerThe size of those attachments, in bytes.
Pelo menos 0deletedFilesintegerDeleted files, listed by name and date but not included.
Pelo menos 0contactsintegerContacts.
Pelo menos 0audiencesintegerAudiences.
Pelo menos 0calendarEventsintegerCalendar events.
Pelo menos 0templatesintegerTemplates.
Pelo menos 0rulesintegerRules.
Pelo menos 0labelsintegerLabels.
Pelo menos 0notesintegerNotes of the caller.
Pelo menos 0addressesintegerAddresses.
Pelo menos 0