निर्यात
इस समूह का हर ऑपरेशन: वह क्या लेता है, क्या लौटाता है और किन त्रुटियों के साथ जवाब दे सकता है।
ऑपरेशन
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.
लौटाता है
What an export would hold, and whether one can start.
त्रुटियाँ
वे त्रुटियाँ जो कोई भी ऑपरेशन लौटा सकता है400401403404422500त्रुटि सूची
इनमें भी उपलब्ध
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.
क्वेरी पैरामीटर
limitintegerExports per page, 1 to 100.
कम से कम 1अधिकतम 100डिफ़ॉल्ट25offsetintegerHow many exports to skip.
कम से कम 0डिफ़ॉल्ट0
लौटाता है
A page of exports, newest first.
त्रुटियाँ
वे त्रुटियाँ जो कोई भी ऑपरेशन लौटा सकता है400401403404422500त्रुटि सूची
इनमें भी उपलब्ध
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.
लौटाता है
The export, queued.
त्रुटियाँ
- 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.
वे त्रुटियाँ जो कोई भी ऑपरेशन लौटा सकता है400401404422500त्रुटि सूची
इनमें भी उपलब्ध
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.
पाथ पैरामीटर
idstringआवश्यकThe export id from
GET /exportsorPOST /exports.
लौटाता है
The export.
त्रुटियाँ
वे त्रुटियाँ जो कोई भी ऑपरेशन लौटा सकता है400401403404422500त्रुटि सूची
इनमें भी उपलब्ध
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.
पाथ पैरामीटर
idstringआवश्यकThe export id from
GET /exportsorPOST /exports.
लौटाता है
application/zipThe zip.
त्रुटियाँ
- 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.
वे त्रुटियाँ जो कोई भी ऑपरेशन लौटा सकता है400401404422500त्रुटि सूची
इनमें भी उपलब्ध
ऑब्जेक्ट
Exportobject
objectstringआवश्यक- इनमें से एक
"export" idstringआवश्यकstatusstringआवश्यक- इनमें से एक
"queued""running""ready""failed""expired" phasestringWhat it is doing while
statusisrunning.null हो सकता हैइनमें से एक"planning""mail""records""finishing"createdAtstringआवश्यक- फ़ॉर्मैट
date-time createdByobjectWho started it, or null when that account is gone.
null हो सकता हैnamestring- null हो सकता है
emailstring
startedAtstring- null हो सकता हैफ़ॉर्मैट
date-time finishedAtstring- null हो सकता हैफ़ॉर्मैट
date-time expiresAtstringWhen the zip is deleted, a year after it was made.
null हो सकता हैफ़ॉर्मैटdate-timesizeBytesinteger- null हो सकता है
fileNamestring- null हो सकता है
threadsDoneinteger- कम से कम 0
threadsTotalinteger- null हो सकता है
errorstringWhy it failed, when
statusisfailed.null हो सकता है
ExportListobject
objectstring- इनमें से एक
"list" dataExport[]totalintegerHow many exports there are in all.
कम से कम 0hasMorebooleanWhether more exports follow this page.
ExportPreviewobject
objectstringआवश्यक- इनमें से एक
"export_preview" allowedbooleanआवश्यकWhether the caller may export this workspace.
reasonstringआवश्यकWhy 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.null हो सकता हैइनमें से एक"not-permitted""mailbox-login""two-factor-required"nextAvailableAtstringआवश्यकWhen the next export can start, or null when one can start now.
null हो सकता हैफ़ॉर्मैटdate-timeactiveExportIdstringआवश्यकThe export still being made, if there is one.
null हो सकता हैcountsobjectआवश्यकHow much an export would hold now. Null when
allowedis false.null हो सकता हैthreadsintegerConversations.
कम से कम 0attachmentsintegerAttachments inside them.
कम से कम 0attachmentBytesintegerThe size of those attachments, in bytes.
कम से कम 0deletedFilesintegerDeleted files, listed by name and date but not included.
कम से कम 0contactsintegerContacts.
कम से कम 0audiencesintegerAudiences.
कम से कम 0calendarEventsintegerCalendar events.
कम से कम 0templatesintegerTemplates.
कम से कम 0rulesintegerRules.
कम से कम 0labelsintegerLabels.
कम से कम 0notesintegerNotes of the caller.
कम से कम 0addressesintegerAddresses.
कम से कम 0