Operation - com.hornbill.docmanager::editDocument

General Description

start editing the document, this will lock the document and notify the timeline that this user is editing the document

Request Message

Input Parameters

The editDocument method takes the following input parameters. It is important to note that the parameters must be passed to the operation in the same order as they appear here in order to satisfy the requirement of the input validation checks.

Name Type Attributes Description
documentId xs:string required once The Id of the document to edit
message xs:string optional The message to add to timeline

Response Message

Output Parameters

The editDocument method returns the following output parameters.

Name Type Attributes Description
status xs:boolean optional True if the edit has succeeded
exceptionName xs:string optional In case of exception, the exception name
exceptionDescription xs:string optional In case of an exception, the exception description to be displayed
Powered by Hornbill, for more information click here. (page served by .)