Documents
  • 25 May 2023
  • 3 Minutes to read
  • Contributors
  • Dark
    Light

Documents

  • Dark
    Light

Article summary


 GET   /documents


Returns a set of documents based on a query string.

Query Parameters
ParameterTypeDescription
indexFieldsStringIndex field options.
  • include: Include index fields.
  • only: Return only index fields.
sortStringThe name of a data column to sort by.
sortDirStringSort direction.
  • asc: Ascending order
  • desc: Descending order
qStringA VisualVault REST API Data Query.
Response Codes
CodeDescription
400Bad Request


 GET   /documents/{id}


Returns a requested document by Document ID.

Route Parameters
ParameterTypeDescription
id*GuidThe document id.


 DELETE   /documents/{id}


Deletes the requested document by Document ID.

Route Parameters
ParameterTypeDescription
id*GuidThe document id.
Query Parameters
ParameterTypeDescription
purgeBoolPermanently delete documents? (Purged documents cannot be recovered.)


 POST   /documents


Creates a new document.
**If 'allowZeroByteFile' is being provided, then the following fields are required: allowNoFile, filename, and fileLength

Body Parameters
ParameterTypeDescription
allowNoFile**BoolAllows a document to be created with no attached file (or a file containing 0 bytes).
folderId*GuidThe folder ID.
name*StringThe customer name.
descriptionStringDocument description.
revisionStringDocument revision number.
documentStateStringDocument status.
  • Unreleased (0)
  • Released (1)
  • Pending (2)
checkInDocumentStateStringDocument status.
  • Unreleased (0)
  • Released (1)
  • Pending (2)
fileLength**StringSize of the file (in bytes).
filename**StringName of the file.
indexFields{IndexField}Index field names and values as a JSON array or object string.
Response Codes
CodeDescription
400Bad Request


 POST   /documents/{id}/copy


Copies a document to another folder.

Route Parameters
ParameterTypeDescription
id*GuidThe document id.
Body Parameters
ParameterTypeDescription
folderIdGuidThe folder ID.
Response Codes
CodeDescription
404Not Found


 PUT   /documents/{id}/move


Moves a document to another folder.

Route Parameters
ParameterTypeDescription
id*GuidThe document id.
Body Parameters
ParameterTypeDescription
folderId*GuidThe folder ID.
Response Codes
CodeDescription
404Not Found


 PUT   /documents/{id}


Updates information about a document.

Route Parameters
ParameterTypeDescription
id*GuidThe document id.
Body Parameters
ParameterTypeDescription
name*StringThe document name.
displayRev*StringThe document display revision.
archiveStringDocument options.
  • Active (0)
  • Archived (1)
  • Deleted (2)
  • Purged (3)
stateStringState.
descriptionStringDocument description.
keywordsStringDocument keywords.
commentsStringDocument comments.
abstactStringDocument abstract. NOTE: Parameter name is a known typo.


 PUT   /documents/{id}/rename


Renames a document or all revisions of a document.

Route Parameters
ParameterTypeDescription
id*GuidThe document id.
Body Parameters
ParameterTypeDescription
renameAllRevisionsBoolRename all revisions of the document?
newName*StringNew name of the document.


 PUT   /documents/{id}/archive


Archives a document.

Route Parameters
ParameterTypeDescription
id*GuidThe document id.


 PUT   /documents/{id}/revision/{childId}/state


Updates document state by revision.

Route Parameters
ParameterTypeDescription
id*GuidThe document id.
childId*GuidThe revision id.
Body Parameters
ParameterTypeDescription
stateStringDocument status.
  • Unreleased (0)
  • Released (1)
  • Pending (2)
checkInDocumentStateStringDocument status.
  • Unreleased (0)
  • Released (1)
  • Pending (2)


 PUT   /documents/{id}/status


Check in or check out a document.

Route Parameters
ParameterTypeDescription
id*GuidThe document id.
Body Parameters
ParameterTypeDescription
checkInStringCheck in status.
  • CheckedIn (0)
  • CheckedOut (1)
statusStringCheck in status.
  • CheckedIn (0)
  • CheckedOut (1)


 GET   /documents/{id}/revisions


Return all revisions of a document.

Route Parameters
ParameterTypeDescription
id*GuidThe document id.
Query Parameters
ParameterTypeDescription
offsetStringSets an offset to the start of the search.
limitIntSets a limit to the number of values returned.


 GET   /documents/{id}/revisions/{childid}


Return a specific document revision.

Route Parameters
ParameterTypeDescription
id*GuidThe document id.
childId*GuidThe revision id.


 GET   /documents/revisions/{id}


Return a specific document revision.

Route Parameters
ParameterTypeDescription
id*GuidThe document revision id.


 DELETE   /documents/revisions/{id}


Delete the requested document revision.

Route Parameters
ParameterTypeDescription
id*GuidThe document revision id.


 GET   /documents/{id}/revisions/{childid}/indexfields


Return all index field information for a document revision.

Route Parameters
ParameterTypeDescription
id*GuidThe document id.
childId*GuidThe revision id.
Query Parameters
ParameterTypeDescription
offsetStringSets an offset to the start of the search.
limitIntSets a limit to the number of values returned.


 GET   /documents/{id}/revisions/{childId}/indexfields/{thirdId}


Return information for a specific index field for a document revision.

Route Parameters
ParameterTypeDescription
id*GuidThe document id.
childId*GuidThe revision id.
thirdId*GuidThe index field id.
Query Parameters
ParameterTypeDescription
offsetStringSets an offset to the start of the search.
limitIntSets a limit to the number of values returned.


 GET   /documents/{id}/indexfields


Return the list of assigned index fields for a document.

Route Parameters
ParameterTypeDescription
id*GuidThe document id.
Query Parameters
ParameterTypeDescription
metaonlyBoolReturn only index field metadata.


 PUT   /documents/{id}/indexfields


Update the index field values for a document.

Route Parameters
ParameterTypeDescription
id*GuidThe document id.
Body Parameters
ParameterTypeDescription
indexFields*StringIndex field names and values as a JSON array or object string.


 GET   /documents/{id}/indexfields/{childid}


Retrieve a specific index field from a document.

Route Parameters
ParameterTypeDescription
id*GuidThe document id.
childId*GuidThe index field id.
Query Parameters
ParameterTypeDescription
metaonlyBoolReturn only index field metadata.


 PUT   /documents/{id}/indexfields/{childid}


Update a specific index field value for a document.

Route Parameters
ParameterTypeDescription
id*GuidThe document id.
childId*GuidThe index field id.
Body Parameters
ParameterTypeDescription
value*StringIndex field value.


 PUT   /documents/{id}/relatedocument


Relate a document to another document.

Route Parameters
ParameterTypeDescription
id*GuidThe ID of the document to relate.
Body Parameters
ParameterTypeDescription
relateToIdGuidThe ID of the document to relate to.
relateTypeStringThe relation type.
  • None (0)
  • Parent (1)
  • Child (2)
  • Peer (3)
  • Project (4)
  • Document_Forms (5)
  • Form_Documents (6)
  • Form_Forms (7)
  • Project_Forms (8)
  • Project_Documents (9)


 GET   /documents/{id}/approvals


Request active document approvals.

Route Parameters
ParameterTypeDescription
id*GuidThe document id.
Query Parameters
ParameterTypeDescription
uidGuidUsId of the associated user.


 POST   /documents/{id}/approvals


No Description.

Route Parameters
ParameterTypeDescription
id*GuidThe document id.
Body Parameters
ParameterTypeDescription
usersStringThe users to assign the approval.
baseUrl*StringBase URL.
requestTitleStringTitle of the approval request.
messageStringMessage to include.
Response Codes
CodeDescription
400Bad Request


 GET   /documents/approvals/{id}


Request an active document approval.

Route Parameters
ParameterTypeDescription
id*intThe approval id.


 PUT   /documents/approvals/{id}


Update an active document approval.

Route Parameters
ParameterTypeDescription
id*intThe approval id.
Body Parameters
ParameterTypeDescription
cancelBoolCancel the approval.
rejectBoolReject the approval.
commentStringApproval comment.
approveBoolApprove the approval.
resubmitBoolResubmit the approval.
reassignBoolReassign the approval.
baseUrlStringBase URL.
user*StringUsId of the associated user.
Response Codes
CodeDescription
400Bad Request


 GET   /documents/{id}/alerts


Get all current document alert subscriptions.

No Parameters.


 POST   /documents/{id}/alerts/{eventId}


Subscribe a user to a document alert.

Route Parameters
ParameterTypeDescription
id*GuidThe document id.
eventId*GuidThe event id.
Query Parameters
ParameterTypeDescription
usId*GuidUsId of the associated user.
Response Codes
CodeDescription
400Bad Request


 DELETE   /documents/{id}/alerts/{eventId}


Cancel a user subscription from a document alert.

Route Parameters
ParameterTypeDescription
id*GuidThe document id.
eventId*GuidThe event id.
Query Parameters
ParameterTypeDescription
usId*GuidUsId of the associated user.
Response Codes
CodeDescription
400Bad Request
404Not Found


 GET   /documents/{id}/ocr


Get OCR properties for a document.

Route Parameters
ParameterTypeDescription
id*GuidThe document id.


 PUT   /documents/{id}/ocr/status


Update the OCR status of a document.

Route Parameters
ParameterTypeDescription
id*GuidThe document id.
Body Parameters
ParameterTypeDescription
ocrErrorCodeStringOCR process error code.
  • None (0)
  • ErrorThrown (1)
  • OcrProcessingError (2)
  • OcrOutputSaveError (3)
  • CheckinError (4)
ocrStatus*StringOCR process progress status.
  • None (0)
  • Success (1)
  • SuccessNoTextExtracted (2)
  • Failure (3)
  • FailureNoRetry (4)
  • ResultingDocumentFromSuccess (5)


 POST   /documents/CreateDocumentZipFile


Download a document compressed in a zip file.

Body Parameters
ParameterTypeDescription
documentDhIds{DhId}List of document DhIds.


 GET   /documents/GetDocumentZipFileStatus


Check the current compression status of a document file.

Query Parameters
ParameterTypeDescription
downloadKeyGuidDownload Key.


 GET   /lastDocuments


Returns the user's last documents.

No Parameters.


 GET   /frequentDocuments


 Returns the user's recent documents.

No Parameters.


 GET   /documentListContextMenu/{documentId}


Returns the document list widget context menu.

Route Parameters
ParameterTypeDescription
documentId*stringThe document id.

Was this article helpful?

What's Next
Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.
ESC

Eddy AI, facilitating knowledge discovery through conversational intelligence