Eksportet
Çdo veprim në këtë grup: çfarë pranon, çfarë kthen dhe gabimet me të cilat mund të përgjigjet.
Veprimet
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.
Kthen
What an export would hold, and whether one can start.
Gabimet
Gabimet që mund të kthejë çdo veprim400401403404422500Katalogu i gabimeve
E disponueshme edhe në
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.
Parametrat e pyetjes
limitintegerExports per page, 1 to 100.
Të paktën 1Më së shumti 100Parazgjedhja25offsetintegerHow many exports to skip.
Të paktën 0Parazgjedhja0
Kthen
A page of exports, newest first.
Gabimet
Gabimet që mund të kthejë çdo veprim400401403404422500Katalogu i gabimeve
E disponueshme edhe në
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.
Kthen
The export, queued.
Gabimet
- 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.
Gabimet që mund të kthejë çdo veprim400401404422500Katalogu i gabimeve
E disponueshme edhe në
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.
Parametrat e shtegut
idstringE detyrueshmeThe export id from
GET /exportsorPOST /exports.
Kthen
The export.
Gabimet
Gabimet që mund të kthejë çdo veprim400401403404422500Katalogu i gabimeve
E disponueshme edhe në
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.
Parametrat e shtegut
idstringE detyrueshmeThe export id from
GET /exportsorPOST /exports.
Kthen
application/zipThe zip.
Gabimet
- 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.
Gabimet që mund të kthejë çdo veprim400401404422500Katalogu i gabimeve
E disponueshme edhe në
Objektet
Exportobject
objectstringE detyrueshme- Një nga
"export" idstringE detyrueshmestatusstringE detyrueshme- Një nga
"queued""running""ready""failed""expired" phasestringWhat it is doing while
statusisrunning.Mund të jetë nullNjë nga"planning""mail""records""finishing"createdAtstringE detyrueshme- Formati
date-time createdByobjectWho started it, or null when that account is gone.
Mund të jetë nullnamestring- Mund të jetë null
emailstring
startedAtstring- Mund të jetë nullFormati
date-time finishedAtstring- Mund të jetë nullFormati
date-time expiresAtstringWhen the zip is deleted, a year after it was made.
Mund të jetë nullFormatidate-timesizeBytesinteger- Mund të jetë null
fileNamestring- Mund të jetë null
threadsDoneinteger- Të paktën 0
threadsTotalinteger- Mund të jetë null
errorstringWhy it failed, when
statusisfailed.Mund të jetë null
ExportListobject
objectstring- Një nga
"list" dataExport[]totalintegerHow many exports there are in all.
Të paktën 0hasMorebooleanWhether more exports follow this page.
ExportPreviewobject
objectstringE detyrueshme- Një nga
"export_preview" allowedbooleanE detyrueshmeWhether the caller may export this workspace.
reasonstringE detyrueshmeWhy 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.Mund të jetë nullNjë nga"not-permitted""mailbox-login""two-factor-required"nextAvailableAtstringE detyrueshmeWhen the next export can start, or null when one can start now.
Mund të jetë nullFormatidate-timeactiveExportIdstringE detyrueshmeThe export still being made, if there is one.
Mund të jetë nullcountsobjectE detyrueshmeHow much an export would hold now. Null when
allowedis false.Mund të jetë nullthreadsintegerConversations.
Të paktën 0attachmentsintegerAttachments inside them.
Të paktën 0attachmentBytesintegerThe size of those attachments, in bytes.
Të paktën 0deletedFilesintegerDeleted files, listed by name and date but not included.
Të paktën 0contactsintegerContacts.
Të paktën 0audiencesintegerAudiences.
Të paktën 0calendarEventsintegerCalendar events.
Të paktën 0templatesintegerTemplates.
Të paktën 0rulesintegerRules.
Të paktën 0labelsintegerLabels.
Të paktën 0notesintegerNotes of the caller.
Të paktën 0addressesintegerAddresses.
Të paktën 0