Objective

It allows to change the metadata in the version of the document. DST must be provided.

Parameters

ParameterDescriptionType
libraryeDOCS libraryString
userUser nameString
passwordUser passwordString
docNumberDocument number. Only one document number is allowed.String
versionVersion number of the document. (1, 2, 3 …).Long
subVersionSubversion letter (A, B, C, …). No letter will be used by default.String
propertiesList of the metadata to be modified in the version. Fields and values must be correct and the only fields available are COMMNETS, AUTHOR, and TYPIST.

New CommentADMIN

String
clientOptional parameter for the client codeString
projectOptional parameter for the project codeString

Rest Invoke

  • http://localhost:port/GSService/xml/ or http://localhost:port/GSService/json/
  • UriTemplate:
    • “/ChangeVersionMetadata/?library={library}&user={user}&password={password}&docNumber={docNumber}&version={version}&subversion={subversion}&properties={properties}&client={client}&project={project}”
    • “/ChangeVersionMetadataDST/?library={library}&user={user}&dst={dst}&docNumber={docNumber}&version={version}&subversion={subversion}&properties={properties}&client={client}&project={project}”

Example

http://localhost:8732/GSService/xml/ChangeVersionMetadata/?library=DMTESTLEGAL&user=admin&password=owc123&docNumber=747&version=1&subversion=!&properties=Pruebametadata2

The method returns 0 if the modification has been applied, or an error.

DST Example 

http://localhost:8732/GSService/xml/ChangeVersionMetadataDST/?library=DMTESTLEGAL&user=admin&dst=afd448a5d0f9b...55355b8c677ad16&docNumber=747&version=1&subversion=!&properties=Pruebametadata2

Error

Check the edocs.log file if errors arise in the update process, most likely related to wrong data or invalid field names in the properties parameter.