Cmdlets for Vault CRM

Build 25.0.9434

UpdateDocument

Executes an update operation on the latest version of a specified document, modifying only editable fields such as metadata or custom attributes without affecting prior versions.

To find the API names of the Documents table, get the Description column for the table Documents:

SELECT Description FROM [sys_tablecolumns] WHERE TableName = 'Documents'

The Description column will contain the API names of the Documents table. Now, use these API names to update a document, for example:

EXEC UpdateDocument DocumentId = '123', name__v = 'new name', product__v = 'new product'

Input

Name Type Required Description
DocumentId String True Required input. Specifies the unique identifier of the document to be updated. This value must match an existing document record in the system.

Result Set Columns

Name Type Description
ResponseStatus String Indicates the outcome of the update operation. Returns a status such as Success, Failure, or ValidationError based on the execution result.
Id String The unique identifier of the document after the update attempt. Matches the input DocumentId if the update is successful.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434