Grist Octri Preview
POST/docs/{docId}/attachments/transferAll

Start transferring document attachments

Starts transferring a document's attachments between storage locations. Use the transfer status to check the current attachment locations and whether a transfer is running.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter
docIdstringrequired
The UUID of the document whose attachments to transfer.

1 status code
200Returns the transfer status, including the current attachment location summary and transfer progress details.
locationSummarystringoptional
The current location of attachment files in the document
Allowed:noneinternalmixedexternal
statusobjectoptional

Error handling

The docId path parameter must be a UUID identifying a document.