|
ExecuteRecycleBinQuery |
Scroll |
REST URL (POST) https://tenant.thereforeonline.com/theservice/v0001/restun/ExecuteRecycleBinQuery
SOAP Action (POST) http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/ExecuteRecycleBinQuery
Executes the query returning deleted Therefore™ documents and cases.
Input Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/ExecuteRecycleBinQuery
Element Name |
Element Type |
Restrictions |
Description |
■ parameters |
|
|
|
■ DeletedByUserNo |
xs:int |
|
Sets the user number of the user that is used for searching deleted objects. Set to 0 or omit it for all users. |
□ DeletedOnFrom |
xs:dateTime |
nillable |
Sets the date specifying the start condition for the deletion date. |
□ DeletedOnTo |
xs:dateTime |
nillable |
Sets the date specifying the end condition for the deletion date. |
□ Target |
|
nillable |
Sets the search target (document(s) or case(s)) of the recycle bin query. |
■ SearchObjectID |
xs:int |
|
The ID of containing object. If SearchObjectType is DocumentObject this refers to the category number. If SearchObjectType is CaseObject this refers to the case definition number. 0 (Zero) or omitted means all categories or all case definitions. |
■ SearchObjectType |
|
restriction enum (xs:string) - Document (2) - Case (38) |
Sets object type to search. |
Output Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/ExecuteRecycleBinQueryResponse
Element Name |
Element Type |
Restrictions |
Description |
■ parameters |
|
|
|
□ DeletedObjects |
|
nillable |
Gets list of the deleted objects. |
≡ WSDeletedObject |
|
list nillable |
|
■ DeletedByUserNo |
xs:int |
|
Gets the ID of the user who deleted the object. |
■ DeletionDateTime |
xs:dateTime |
|
Gets the date and time (in UTC) when the object has been deleted. |
□ DisplayText |
xs:string |
nillable |
Gets the text that is displayed in the recycle bin dialog. |
■ HasCustomData |
xs:boolean |
|
Gets whether the object was deleted in an older version than Therefore 2015. |
■ Id |
xs:int |
|
Gets the ID of the deleted object. |
■ ParentObjectID |
xs:int |
|
Gets the ID of the parent/containing object. |
□ ParentObjectType |
|
nillable restriction enum (xs:string) - Unknown (-1) - Server (1) - Document (2) - Category (3) - Field (4) - DataType (5) - MediaPool (6) - Media (7) - IndexingProfile (8) - SpoolType (9) - Query (10) - User (11) - Group (12) - CaptureProfile (13) - PreProcessor (14) - COLDForm (15) - QueryTemplate (16) - Folder (17) - LoaderProfile (18) - WorkflowProcess (19) - WorkflowTask (20) - WorkflowInstance (21) - KeyDict (22) - StoragePolicy (23) - Device (24) - StorageArea (25) - RetentionPolicy (26) - Count (27) - UniversalConnectorProfile (29) - CaseDefinition (37) - Case (38) - Stamp (40) - ReportDefinition (41) - eForm (47) - eFormSubmission (48) - FormImage (99) - Keyword (100) - Migrate (101) - Connectors (900) - StorageCtgry (901) - ServerMediaPools (902) - StorageAreaMedia (903) - ServerDevices (904) - ServerMedia (905) - TheSystem (1000) - COLD (1001) - ExchangeConnector (1002) - LotusConnector (1003) - SAPConnector (1004) |
Gets the type of the parent/containing object (e.g. Category, Case Definition). |
■ ParentParentObjectID |
xs:int |
|
Gets the ID of the parent's parent object. |
□ ParentParentObjectType |
|
nillable restriction enum (xs:string) - Unknown (-1) - Server (1) - Document (2) - Category (3) - Field (4) - DataType (5) - MediaPool (6) - Media (7) - IndexingProfile (8) - SpoolType (9) - Query (10) - User (11) - Group (12) - CaptureProfile (13) - PreProcessor (14) - COLDForm (15) - QueryTemplate (16) - Folder (17) - LoaderProfile (18) - WorkflowProcess (19) - WorkflowTask (20) - WorkflowInstance (21) - KeyDict (22) - StoragePolicy (23) - Device (24) - StorageArea (25) - RetentionPolicy (26) - Count (27) - UniversalConnectorProfile (29) - CaseDefinition (37) - Case (38) - Stamp (40) - ReportDefinition (41) - eForm (47) - eFormSubmission (48) - FormImage (99) - Keyword (100) - Migrate (101) - Connectors (900) - StorageCtgry (901) - ServerMediaPools (902) - StorageAreaMedia (903) - ServerDevices (904) - ServerMedia (905) - TheSystem (1000) - COLD (1001) - ExchangeConnector (1002) - LotusConnector (1003) - SAPConnector (1004) |
Gets the type of the parent's parent object (e.g. Case for a deleted Case Document). |
Legend:
■ |
Not nillable element. |
□ |
Nillable element. |
≡ |
List of elements. |
Bold |
Mandatory element. |
