Create References

 

Function Name: getCreateReferencesXml

 

Class: com.newgen.dmsapi.DMSInputXml

 

Description: This function is used to create Shortcuts (also termed as References) of a set of documents or a Folder in other Folder. The ObjectType is D for document and F for Folder.  ObjectIndex is the corresponding Index of the Object.

 

Input Parameters

Sample InputXML

Output Parameters

Sample OutputXML

View xml API::NGOCreateReferences

  

 

Prototype:

public String getCreateReferencesXml

(

 

 

 

String cabinetName,

 

 

String userDbId,

 

 

String creationDateTime,

 

 

String objectIndex,

 

 

String foldDocFlag,

 

 

String destFolder

 

)

 

 

 

Input Parameters:

Name

Description

Valid Values

Default Behaviour

cabinetName

Name of the Database Cabinet to which the User wants to connect.

 

N/A

userDbId

UserDatabase ID, which is returned in the ConnectCabinet call.

 

N/A

creationDateTime

Current Date and Time when the Reference was created.

Valid Date in the format yyyy-mm-dd hh:mm:ss

Current Date and Time

objectIndex

Index of the Object whose shortcut is to be created.

Integer > 0

N/A

foldDocFlag

Type of the Object.

D-Document

F-Folder

N/A

destFolder

Index of the Destination Folder where the shortcut is to be created.

Integer >= 1

N/A

 

Output Parameters:

An Input Xml for NGOCreateReferences.