OUouterport
Documents

Update a document

Changed on

Updates a document's properties by its unique identifier.

put/api/v0/documents/{document_id}

Request

Path parameters

document_idstring uuid required

Request body

namestring nullable

The name of the document

folder_idstring uuid nullable

The ID of the folder containing the document

summarystring nullable

The summary of the document

Response

Successful Response

idstring uuid required

The ID of the document.

namestring required

The name of the document.

folder_idstring uuid nullable required

The ID of the folder that contains the document.

file_pathstring nullable required

The path to the document file.

file_typestring required

The type of the document file. Options: pdf, docx, txt, html, md.

file_urlstring nullable required

The URL of the document file.

summarystring required

A summary of the document content.

visibilitystring required

The visibility of the document. Options: private, org.

num_pagesinteger required

The number of pages in the document.

versioninteger required

The version of the document.

job_status_idstring uuid nullable

The public UUID of the job status for the document's current processing job.

job_statusstring nullable

The current job status: queued, processing, done, error, cancelled.

batch_pendingboolean

True while the document still has deferred batch work in flight: a job that processed it in batch mode has finished, and its table content or descriptions are still empty pending provider-batch results, minutes to hours away. job_status may meanwhile report a later job on the document. Content read while this is True is not final.

created_atstring date-time required

The date and time the document was created.

updated_atstring date-time required

The date and time the document was last updated.

tagsstring[] required

The tags associated with the document.

Changes

  • fcd15f6d35b4Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status