Search API¶

Prepares a search result set using criteria provided in XML format. The search is executed server-side and the results are stored in the user's session. Use GetNextSearchPage and GetPreviousSearchPage to page through the results after calling Search.

Endpoint¶

/srv.asmx/Search

Methods¶

• GET /srv.asmx/Search?authenticationTicket=...&xmlcriteria=...&SortBy=...&AscendingOrder=...

• POST /srv.asmx/Search (form data)

• SOAP Action: http://tempuri.org/Search

Parameters¶

Sort Field Values¶

XML Criteria Reference¶

The xmlcriteria parameter must be a well-formed XML document. The root element may have any name; each child <criteria> element defines one search condition.

Envelope:

<criteria>

  <criteria NAME="..." OPERATOR="..." VALUE="..." />

  ...

</criteria>

Each element uses three attributes:

Supported Criteria Elements¶

AI Enhanced Criteria¶

AIENHANCED filters on which of a document's attributes infoRouter Connect produced. Everything is said in VALUE; there is no OPERATOR.

The attribute names are the ones the AIEnhanced attribute reports on each document - SUMMARY, DESCRIPTION, KEYWORDS, OCRTEXT, DOCUMENTTYPE, ABSTRACT, EXTRACTEDDATA, MARKDOWN, REDACTEDTEXT. See AIEnhanced for what each one means. Case and spacing do not matter.

<!-- documents a model has touched at all -->
<criteria NAME="AIENHANCED" VALUE="ANY" />

<!-- documents no model has touched -->
<criteria NAME="AIENHANCED" VALUE="NONE" />

<!-- documents whose summary Connect wrote -->
<criteria NAME="AIENHANCED" VALUE="SUMMARY" />

<!-- documents carrying both a generated summary and a generated abstract -->
<criteria NAME="AIENHANCED" VALUE="SUMMARY,ABSTRACT" />

Notes:

• Documents only. The flag lives on documents, so a search carrying this criterion returns no folders and no shortcuts, in the same way DOCTYPE and IMPORTANCE already do.
• A list means all of the names, not any of them. SUMMARY,ABSTRACT is a document carrying both. To find documents with either, run the two searches.
• ANY, ALL and NONE cover every attribute, including ones added in later releases, so a search written today keeps meaning what it says.
• A VALUE that is neither one of the three words nor a known attribute name is rejected, and the error lists what it could have been. A misspelt attribute fails rather than quietly narrowing the search.

Date Criteria Subtypes¶

The DATECRITERIA element requires a SUBTYPE attribute to specify which date field to filter by:

Example:

<criteria NAME="DATECRITERIA" OPERATOR="EQGT" SUBTYPE="CREATED" VALUE="2025-01-01" />

<criteria NAME="DATECRITERIA" OPERATOR="BETWEEN" SUBTYPE="MODIFIED" VALUE="2024-01-01|2024-12-31" />

Document Language Values¶

The DOCLANG criterion accepts the following ISO 639-1 language codes:

en, de, es, fr, da, el, et, he, hi, hu, id, it, ja, ko, nl, no, pl, pt, ro, ru, sv, tk, tr, uk, ur, uz, vi, zh

Property Set Criteria¶

To filter by the values of a custom property set, add a PROPERTYSETNAME element whose VALUE is the property set name, with one child element per field to filter on:

<criteria NAME="PROPERTYSETNAME" VALUE="Invoice">
  <criteria NAME="Customer" OPERATOR="LIKE"    VALUE="Acme" />
  <criteria NAME="Amount"   OPERATOR="BETWEEN" VALUE="1000|5000" />
  <criteria NAME="DueOn"    OPERATOR="BETWEEN" VALUE="2026-01-01|2026-03-31" />
  <criteria NAME="Paid"     OPERATOR="EQ"      VALUE="false" />
</criteria>

A document matches only if it meets every field condition (they are combined with AND). Field names are not case sensitive. A field of the set that has no child element puts no condition on the search.

Operators by field type¶

• Operators are not case sensitive.
• BETWEEN takes two values separated by |, as DATECRITERIA does; ; is accepted as well. Both ends are included. For a date written without a time, the end date counts as the whole day: 2026-01-01|2026-03-31 includes documents dated 31 March. An end date with a time is taken at that time.
• Write dates as yyyy-MM-dd. EQ, EQGT and EQLT compare whole days; a time in the value is ignored.
• An operator that does not exist for the field's type is refused, for example BETWEEN on a text field or NOTNULL on a date field (use ANYTIME).
• An operator that takes no value (NULL, NOTNULL, ANYTIME, TODAY, ...) must be sent with an empty VALUE; a value is refused.

Examples by field type¶

The examples use a property set Invoice with a text field Customer, a number field Amount, a date field DueOn and a yes/no field Paid. Each PROPERTYSETNAME element below is one complete property set criterion; put it inside the <criteria> root with any other criteria.

Text (CHAR)

<criteria NAME="PROPERTYSETNAME" VALUE="Invoice">
  <criteria NAME="Customer" OPERATOR="LIKE"        VALUE="Acme" />      <!-- contains "Acme" -->
</criteria>

<criteria NAME="PROPERTYSETNAME" VALUE="Invoice">
  <criteria NAME="Customer" OPERATOR="EQ"          VALUE="Acme Ltd" />  <!-- exactly "Acme Ltd" -->
</criteria>

<criteria NAME="PROPERTYSETNAME" VALUE="Invoice">
  <criteria NAME="Customer" OPERATOR="NOTCONTAINS" VALUE="Test" />      <!-- does not contain "Test" -->
</criteria>

<criteria NAME="PROPERTYSETNAME" VALUE="Invoice">
  <criteria NAME="Customer" OPERATOR="NULL"        VALUE="" />          <!-- no customer entered -->
</criteria>

Number (NUMBER)

<criteria NAME="PROPERTYSETNAME" VALUE="Invoice">
  <criteria NAME="Amount" OPERATOR="BETWEEN" VALUE="1000|5000" />  <!-- 1000 to 5000, both included -->
</criteria>

<criteria NAME="PROPERTYSETNAME" VALUE="Invoice">
  <criteria NAME="Amount" OPERATOR="EQGT"    VALUE="10000" />      <!-- 10000 or more -->
</criteria>

<criteria NAME="PROPERTYSETNAME" VALUE="Invoice">
  <criteria NAME="Amount" OPERATOR="NOTEQ"   VALUE="0" />          <!-- anything but 0 -->
</criteria>

Date (DATE)

<criteria NAME="PROPERTYSETNAME" VALUE="Invoice">
  <criteria NAME="DueOn" OPERATOR="BETWEEN"   VALUE="2026-01-01|2026-03-31" />  <!-- the first quarter, 31 March included -->
</criteria>

<criteria NAME="PROPERTYSETNAME" VALUE="Invoice">
  <criteria NAME="DueOn" OPERATOR="EQLT"      VALUE="2026-06-30" />             <!-- on or before 30 June -->
</criteria>

<criteria NAME="PROPERTYSETNAME" VALUE="Invoice">
  <criteria NAME="DueOn" OPERATOR="NEXT7DAYS" VALUE="" />                       <!-- due in the coming week -->
</criteria>

<criteria NAME="PROPERTYSETNAME" VALUE="Invoice">
  <criteria NAME="DueOn" OPERATOR="ANYTIME"   VALUE="" />                       <!-- has a due date at all -->
</criteria>

Yes/No (BOOLEAN)

<criteria NAME="PROPERTYSETNAME" VALUE="Invoice">
  <criteria NAME="Paid" OPERATOR="EQ"   VALUE="false" />  <!-- not paid -->
</criteria>

<criteria NAME="PROPERTYSETNAME" VALUE="Invoice">
  <criteria NAME="Paid" OPERATOR="NULL" VALUE="" />       <!-- never set -->
</criteria>

Several fields at once. All conditions must hold: unpaid invoices of Acme between 1,000 and 5,000, due in the first quarter.

<criteria>
  <criteria NAME="SEARCHFOR" VALUE="DOCUMENTSONLY" />
  <criteria NAME="PROPERTYSETNAME" VALUE="Invoice">
    <criteria NAME="Customer" OPERATOR="LIKE"    VALUE="Acme" />
    <criteria NAME="Amount"   OPERATOR="BETWEEN" VALUE="1000|5000" />
    <criteria NAME="DueOn"    OPERATOR="BETWEEN" VALUE="2026-01-01|2026-03-31" />
    <criteria NAME="Paid"     OPERATOR="EQ"      VALUE="false" />
  </criteria>
</criteria>

When OPERATOR is missing or VALUE is empty¶

An operator other than BETWEEN sent with an empty value is not refused, so a search built from a form with empty inputs silently matches more documents rather than failing. Leave a field out, or check its value, before sending it.

Errors¶

Response¶

Search prepares the result set and stores it in the session. The response confirms the query was accepted and includes metadata about the total result counts.

Success Response¶

<response success="true" ranksorted="false" />

After a successful Search call, use GetNextSearchPage to retrieve the first page of results.

Relevance and Where the Term Was Found¶

Search itself returns no items, so it carries no per-document relevance either - only ranksorted, which says whether the pages that follow will come back in relevance order. The relevance of each document, and which part of it the term was found in, arrive with the items themselves: every document a full-text KEYWORDS search ranked carries a <RankInfo> child element in the GetNextSearchPage and GetPreviousSearchPage responses.

<RankInfo Rank="95" FoundIn="1" FoundInVersionNumber="3000000" />

A higher Rank is a closer match. FoundIn says where the term was found, as a number: 1 the text of the document itself (in the version FoundInVersionNumber names), 2 its properties or comments, 3 an e-mail attachment, 4 a workflow history entry, 0 unknown. A document matched by database criteria alone - no KEYWORDS element in the criteria, or a keyword the content search engine did not rank - carries no <RankInfo> element at all. See GetNextSearchPage for the full attribute table and suggested captions.

Error Response¶

<response success="false" error="Error message" errorCode="4000" />

Required Permissions¶

Any authenticated user may call this API. Read-only users may also use it.

Results are always limited to libraries the user can view. Whether each hit is also checked against the item's own permissions depends on the server setting Search:CheckSecurityOnSearch, which is off by default. With it off, a hit in a library the user belongs to is returned even when the item's permissions would deny reading it; opening the item still fails. With it on, every hit is checked for Read (documents) or List (folders) permission before it is returned.

Example¶

GET Request¶

GET /srv.asmx/Search?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301

  &xmlcriteria=%3Ccriteria%3E%3Ccriteria+NAME%3D%22KEYWORDS%22+VALUE%3D%22annual+report%22%2F%3E%3C%2Fcriteria%3E

  &SortBy=MODIFICATIONDATE

  &AscendingOrder=false

HTTP/1.1

POST Request¶

POST /srv.asmx/Search HTTP/1.1

Content-Type: application/x-www-form-urlencoded

authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301

&xmlcriteria=<criteria>

    <criteria NAME="FOLDER"            VALUE="/Finance/Reports" />

    <criteria NAME="INCLUDESUBFOLDERS" VALUE="true" />

    <criteria NAME="DATECRITERIA"      OPERATOR="EQGT" SUBTYPE="MODIFIED" VALUE="2025-01-01" />

    <criteria NAME="SEARCHFOR"         VALUE="DOCUMENTSONLY" />

  </criteria>

&SortBy=MODIFICATIONDATE

&AscendingOrder=false

SOAP Request¶

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"

               xmlns:tns="http://tempuri.org/">

  <soap:Body>

    <tns:Search>

      <tns:authenticationTicket>3f2504e0-4f89-11d3-9a0c-0305e82c3301</tns:authenticationTicket>

      <tns:xmlcriteria>&lt;criteria&gt;

        &lt;criteria NAME="KEYWORDS" VALUE="annual report"/&gt;

      &lt;/criteria&gt;</tns:xmlcriteria>

      <tns:SortBy>MODIFICATIONDATE</tns:SortBy>

      <tns:AscendingOrder>false</tns:AscendingOrder>

    </tns:Search>

  </soap:Body>

</soap:Envelope>

Full Criteria Example -" Advanced Search¶

<criteria>

  <criteria NAME="SEARCHSCOPE"       VALUE="ONLINE" />

  <criteria NAME="KEYWORDS"          VALUE="quarterly budget" />

  <criteria NAME="FOLDER"            VALUE="/Finance/Reports" />

  <criteria NAME="INCLUDESUBFOLDERS" VALUE="true" />

  <criteria NAME="SEARCHFOR"         VALUE="DOCUMENTSONLY" />

  <criteria NAME="DATECRITERIA"      OPERATOR="BETWEEN" SUBTYPE="MODIFIED" VALUE="2024-01-01|2024-12-31" />

  <criteria NAME="IMPORTANCE"        OPERATOR="EQ" VALUE="HIGH" />

  <criteria NAME="PUBLISHSTATUS"     VALUE="2" />

  <criteria NAME="AIENHANCED"        VALUE="SUMMARY" />

  <!-- One condition per field type: text, number (BETWEEN), date (BETWEEN) and yes/no -->

  <criteria NAME="PROPERTYSETNAME"   VALUE="ProjectMetadata">

    <criteria NAME="Department" OPERATOR="EQ"      VALUE="Finance" />

    <criteria NAME="Budget"     OPERATOR="BETWEEN" VALUE="50000|250000" />

    <criteria NAME="StartDate"  OPERATOR="BETWEEN" VALUE="2024-01-01|2024-06-30" />

    <criteria NAME="Approved"   OPERATOR="EQ"      VALUE="true" />

  </criteria>

</criteria>

User-Scoped Search Examples¶

<!-- Items subscribed to by a user -->

<criteria>

  <criteria NAME="SUBSCRIPTIONSOF" VALUE="jsmith" />

</criteria>

<!-- Items in a user's favorites -->

<criteria>

  <criteria NAME="FAVORITESOF" VALUE="jsmith" />

</criteria>

<!-- Current user's recent documents -->

<criteria>

  <criteria NAME="RECENTDOCUMENTS" />

</criteria>

<!-- Items in a user's download queue -->

<criteria>

  <criteria NAME="DOWNLOADQUEOF" VALUE="jsmith" />

</criteria>

JavaScript¶

Every call answers XML with HTTP 200, success or not, so success is the thing to branch on and errorCode is the number to report.

async function call(action, params) {
  const response = await fetch(`/srv.asmx/${action}?${new URLSearchParams(params)}`);
  const root = new DOMParser()
    .parseFromString(await response.text(), 'text/xml')
    .documentElement;

  if (root.getAttribute('success') !== 'true') {
    throw new Error(`${root.getAttribute('errorCode')}: ${root.getAttribute('error')}`);
  }
  return root;
}

Runs a search and answers how many things matched - not the things themselves. The rows come from GetNextSearchPage, which reads the result your session is holding, so the two are always used together.

const criteria = `
<criteria>
  <item NAME="FOLDER" OPERATOR="" VALUE="/Finance/Invoices" />
  <item NAME="INCLUDESUBFOLDERS" OPERATOR="" VALUE="true" />
  <item NAME="KEYWORDS" OPERATOR="" VALUE="overdue" />
</criteria>`;

const found = await call('Search', {
  authenticationTicket: ticket,
  xmlcriteria: criteria,
  SortBy: 'DOCUMENTNAME',
  AscendingOrder: true
});
console.log(found.getAttribute('count'), found.getAttribute('ranksorted'));

const page = await call('GetNextSearchPage', {
  authenticationTicket: ticket,
  withrules: false, withPropertySets: false,
  withSecurity: false, withOwner: false, withVersions: false
});
for (const document of page.querySelectorAll('document')) {
  console.log(document.getAttribute('Name'), document.getAttribute('Path'));
}

xmlcriteria¶

A root element whose children each carry NAME, OPERATOR and VALUE attributes. The element names themselves are not read. A name the parser does not know is refused 4000 and the message quotes it. An empty <criteria /> matches nothing rather than everything.

The names include SEARCHSCOPE, SEARCHFOR, KEYWORDS, DOCUMENTNAME, DOCUMENTID, FOLDER, FOLDERBYID, INCLUDESUBFOLDERS, FOLDERDESCRIPTION, DOCUMENTFORMAT, DOCTYPE, FOLDERSONLY, DOCUMENTSONLY, OBJECTTYPENAME, VIEWCRITERIA, CHECKOUTSTATUS, USERNAME, SIZEIS, IMPORTANCE, CLEVEL, DATECRITERIA, DOCSRC, DOCLANG, DOCAUTHOR, RDDEFID, TEMPLATEPATH, PUBLISHSTATUS, AIENHANCED, SUBSCRIPTIONSOF, FAVORITESOF, RECENTDOCUMENTS, DOWNLOADQUEOF and PROPERTYSETNAME.

SortBy¶

Required - it is a non-nullable string, so it cannot be left out even though the search has a default sort of its own. A column it does not know is refused 4000 and the message lists them all: DOCUMENTNAME, DOCUMENTSIZE, MIMETYPEDESCRIPTION, MODIFICATIONDATE, STATUSCODE, FOLDERNAME, LASTVERSIONNUMBER, PERCENTCOMPLETE, CREATIONDATE, MODIFIEDBYNAME, DESCRIPTION, OWNERNAME, FLOWNAME, VIEW, CHECKEDOUTBYNAME, COMPLETIONDATE, IMPORTANCE, RDDEFID, CLEVEL, DECLASSIFYON, DOWNGRADEON, DISPOSITIONDATE, LASTISOREVIEW, NEXTISOREVIEW, and PROPERTYSETNAME.FIELDNAME for a custom field.

A criteria document that is not well formed is refused with 4000, the same as a criterion name the parser does not recognise.

Notes¶

• The Search API only prepares the result set; it does not return document listings. Call GetNextSearchPage immediately after to retrieve the first page.

• Result sets are stored server-side in the user's session and expire with the session (30-day sliding window).

• Passing an empty string for xmlcriteria returns all documents and folders accessible to the user, subject to permissions.

• Passing an empty string for SortBy uses the system default sort (by document name, ascending).

• Full-text search (KEYWORDS) requires a content search service (Windows Search, DTSearch, or Remote Search) to be configured and running. If no content search service is available, keyword searches return only metadata matches.

• The DATECRITERIA value for BETWEEN uses a pipe (|) separator: startDate|endDate in yyyy-MM-dd format.

• The DATECRITERIA operator EQLT means "on or before the given date"; EQGT means "on or after the given date"; EQ means exactly on the given date.

• The CHECKOUTSTATUS value CHECKEDOUTBYUSER requires an additional USERNAME attribute on the same element specifying the target user's login name.

• The VIEWCRITERIA criterion can optionally include a USERNAME attribute to filter by another user's view history.

• The SUBSCRIPTIONSOF, FAVORITESOF, and DOWNLOADQUEOF criteria require the VALUE attribute to be a valid infoRouter username; an error is returned if the user is not found.

• SUBSCRIPTIONSOF, FAVORITESOF, DOWNLOADQUEOF and VIEWCRITERIA with USERNAME read another user's activity, so for a user other than the caller they need the right the dedicated calls need (GetSubscribedDocumentsByUser, GetFavoriteDocumentsOfUser, GetUserViewLog): an administrator, a User Manager, or a manager of that user's library. A co-worker is refused with 4030. Naming yourself always works.

• The RECENTDOCUMENTS criterion returns recent documents for the currently authenticated user only; no VALUE attribute is required.

• Property set field names are case-insensitive. A property set name that does not exist is refused with 4041.

• The TEMPLATEPATH criterion accepts either a full infoRouter document path (e.g. /Finance/Templates/mytemplate.htm) or the short-form ~D<id> notation (e.g. ~D42). Use ~D999 as the reserved identifier for all HTML form documents — it matches any document whose template is the built-in HTML document type regardless of which specific template file was used.

Related APIs¶

• GetNextSearchPage - Retrieves the next page of the prepared search results

• GetPreviousSearchPage - Retrieves the previous page of the prepared search results

• GetFoldersAndDocuments - Lists documents and folders in a specific path without a search query

• GetDocuments - Returns documents in a specific folder path

Error Codes¶

The errorCode values this operation returns, checked against a running server: