Scenario:
When using the “Get documents” example from the Postman Collection, it only retrieves all documents in the trash bin. However, you need to search for specific documents within the trash bin using the REST API.
Solution:
To search for specific documents in the trash bin using the REST API, a condition must be added to the request's body. Use the “Get documents” endpoint:
{{ServerUrl}}/{{Platform}}/TrashBin/Query
Note: By product design, deleted items can only be retrieved within a 30-day limitation. Any documents older than 30 days are permanently deleted and cannot be retrieved.
Please include the following body to designate your search criteria:
{
"CompleteCondition": null,
"Expression": {"Condition":
[
{
"DBName":"DOCUMENTNAME",
"Value":["SearchValue"]
}
]
},
"SortOrder": [
{
"Field": "DELETEDATETIME",
"Direction": "Desc"
}
],
"ForceRefresh": true,
"Operation": "And",
"AdditionalResultFields": [],
"Start": 0,
"Count": 100,
"IncludeSuggestions": false
}
Note: The 'DBName' "DOCUMENTNAME" corresponds to the Name column shown in the trash bin.
Once you send the request, only the documents meeting the search criteria will be provided.
KBA applicable for both Cloud and On-premise Organizations
Scenario:
When using the “Get documents” example from the Postman Collection, it only retrieves all documents in the trash bin. However, you need to search for specific documents within the trash bin using the REST API.
Solution:
To search for specific documents in the trash bin using the REST API, a condition must be added to the request's body. Use the “Get documents” endpoint:
{{ServerUrl}}/{{Platform}}/TrashBin/Query
Note: By product design, deleted items can only be retrieved within a 30-day limitation. Any documents older than 30 days are permanently deleted and cannot be retrieved.
Please include the following body to designate your search criteria:
{
"CompleteCondition": null,
"Expression": {"Condition":
[
{
"DBName":"DOCUMENTNAME",
"Value":["SearchValue"]
}
]
},
"SortOrder": [
{
"Field": "DELETEDATETIME",
"Direction": "Desc"
}
],
"ForceRefresh": true,
"Operation": "And",
"AdditionalResultFields": [],
"Start": 0,
"Count": 100,
"IncludeSuggestions": false
}
Note: The 'DBName' "DOCUMENTNAME" corresponds to the Name column shown in the trash bin.
Once you send the request, only the documents meeting the search criteria will be provided.
KBA applicable for both Cloud and On-premise Organizations.