Archived documents can be searched 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 SQL query statement as a JSON string that must have at least the FROM condition matching the archive. All identifiers are case sensitive and must be enclosed with single quotation marks. All keywords must be upper-case. Only SELECT statements are allowed. Selecting fields is not supported. JOIN conditions and sub queries are also not supported. WHERE conditions can be combined and access nested properties. Range conditions are supported for numeric values and dates.

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

cURL Example

curl -X 'POST' \
    'https://{fqdn_helix}/api/v2/ArchiveApi/search' \
    -H 'accept: application/json' \   
    -H "Authorization: Bearer {ACCESS_TOKEN}" \   
    -H 'Content-Type: application/json' \  
    -d '"SELECT * FROM '\''cst_Invoice'\'' WHERE '\''SapParameters.IndexStatus'\'' = 0 AND '\''Created'\'' > '\''2025-02-05T09:10:42.688Z'\'' AND
'LitigationHold'\'' IS NULL LIMIT 1,0"'

Performs a meta data search for the first document in archive 'cst_Invoice', having the status of "Indexer for SAP index" = 0 (Unknown), is created after 2025-02-05T09:10:42.688 UTC, and has no litigation hold applied.

Definitions

See list operation in Archive Service API.

Permissions

Query permissions on the archive are needed.