dms.GetDeletedObjects

This job can be used to output the content of the logged-in user’s trash bin. The result is returned in the DMS Content format. The same output format options apply as for the job dms.GetResultList.

A search within the trash can can also be performed. For this, a request must be formulated in DMSQuery XML format and passed as the XML parameter.

1. Input Parameters

Name Type Required Description

Flags

INT

Yes

Flags to control the output format
0x00000010 (16) = XML result is returned as a file, otherwise as a buffer
0x00001000 (4096) = XML result is encoded in UTF-8, otherwise UTF-16

[UserID]

INT

No

ID of the user whose trash can is to be read. With the value -1 the entire system trash can is read, the default value 0 denotes the logged-in user. To read the system trash can or the trash can of another user, the system role 'Client: Show system trash can' is required, otherwise an 'Access denied' error code (-1069) is returned.

[XML]

BASE64

No

Request in DMSQuery format (search in the trash can)

[CheckParams]

INT

No

0 = If no value is defined for a request parameter, conditions that reference this parameter are ignored. This is the default value. 1 = An error message is generated if a referenced parameter is not defined.

2. Output Parameters

Name Type Dependency Description

Count

INT

—

Number of records returned

TotalHits

INT

—

Number of available hits

[XML]

BASE64

Optional

Hit list in DMSContent XML format (when Flags is not 0x00000010 (16))

3. Output Files

Name Description

[FileCount]

Only one file is always returned

[File list]

Name and path of the DMSContent XML file containing the hit list

4. Return Value

(INT): 0 = Job successful, otherwise error code
Complete error list