PurgeLog

Function Name: getPurgeLogXml

Class: com.newgen.dmsapi.DMSInputXml

Description: This function is used to purge or delete the Log, generated for the Objects. If the Log for some specific Actions is to be purged, then the Action Indexes for those Logs should be sent, otherwise, null is sent to purge the Log for all the Actions. Also, the particular groups, Users or ActionLogIds and the Objects for which the Log is to be purged can be specified. Null is sent to fetch the Log for all.

Input Parameters	Sample InputXML
Output Parameters	Sample OutputXML
View xml API::NGOGetPurgeLog

Prototype:

public String getPurgeLogXml	(
		String cabinetName,
		String userDbId,
		String actionIdList,
		String actionLogIdList,
		String groupUserIdList,
		String groupUserFlag,
		String objectIdList,
		String objectType,
		String dateFrom,
		String dateTo
	)

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 after the execution of getConnectCabinetXml call.		N/A
actionIdList	It specifies a List of Action Indexes of the Logs that are to be purged. The List is generated by the function getActionId.		N/A
actionLogIdList	It contains a List of Ids corresponding to which the Log is to be purged. The List is generated by the function getActionLogId.		For all defined Action Log will be purged.
groupUserIdList	It specifies a List of Group or User Indexes for whom all the Log that was generated is to be purged.		Log will be purged for all Groups and Users who have performed the Action.
groupUserFlag	It specifies whether the call for Purge Log is for a Group or a User.	G – Group U – User	It will purge the Log for all Users and Groups who have performed the Action according to Action specified.
objectIdList	It specifies a List of those Object Indexes for which the Log is to be purged. The List is generated by the function getObjectIndexXml.		N/A
objectType	It specifies the Type of the Objects (whose Indexes are sent in the ObjectIndex tags).	‘C’ -Cabinet ‘F’ - Folder ‘D’ - Document ‘A’ - Annotation ‘T’ – Data Class	For all Objects, Log will be purged.
dateFrom	Specifies the Date starting from which, the Log is to be purged.	Date in yyyy-mm-dd hh:mm:ss format.	No limit for Date. All the Logs should be fetched.
dateTo	Specifies the Date up to which, the Log is to be purged.	Date in yyyy-mm-dd hh:mm:ss format.	No limit for Date. All the Logs should be fetched.

Output Parameters:

An inputXml string of the NGOGetPurgeLog call.