Document AI — DMS

Acquire Edit-Session (Presence-Lock)

Acquire a cooperative metadata edit lock that expires after 90 seconds without a heartbeat. If another user is editing, the response returns status=readonly. Call po_documents_edit_session_heartbeat at least every 30 seconds while editing.

post/documents/document-edit-session-acquire/{pofid}

Request

  • Base URL: https://api.paperoffice.ai/latest
  • URL: https://api.paperoffice.ai/latest/documents/document-edit-session-acquire/{pofid}
  • Auth: HTTP bearer

Path parameters

pofidstring required

PaperOffice document ID (pofid) — URL path parameter or request body.

Response

Success

status'success' required
_billingobject

Changes

No recorded changes to this operation across all 1 revision of this API.