Archived documents can be searched with this API currently only by meta data. Fulltext searches and searching by content will be released in future versions of this API.

Meta data search is performed by providing a search expression as a JSON string that must have at least one condition. Conditions operate on a single meta data key and have an operator and a value. Range conditions are supported for numeric values and dates.

When multiple conditions are used, then each condition must be enclosed by enclosing parentheses and concatenated with AND.

Currently meta data search always searches document and attachment meta data.

cURL Example

POST "https://{customer}.{tenant}.cp.xsuite.com:{port}/api/v1/Archives/sys_Invoice/list?skip=0&max=200" -H "Authorization: Bearer {ACCESS_TOKEN}" -H "accept: application/json" -H "Content-Type: application/json-patch+json" -d "\"DocumentType=\\\"sys_Invoice\\\"\""

Performs a meta data search for documents having a meta data key DocumentType with a value of sys_Invoice.

Definitions

See list operation in Archive Service API

Permissions

Query permissions on the archive are needed.