Application Broker 3.10 Query Service

The following operations are available. For a formal definition, please review the Service Description.

• createSearch

  Creates a new query with the specified criteria.

  Returns the ID of the new query.

  For criteria supporting lists of possible values, Value can contain several values separated by semicolons (just semicolons, no spaces).

  For valid criteria names and values, see this page.

• dateOfFirstResult

  Returns the creation date and time of the first result matching the specified query. Note that if the query contains creation date constraints, these will be ignored!

• startSearch

  Runs the specified query.

• doSearch

  Creates a query with the specified criteria and runs it.

  Returns the ID of the new query.

  Identical in function to createSearch followed by startSearch.

• doDiff

  Creates a diff query based on the specified query and runs it.

  Returns the ID of the new query.

  The specified ParentSearch must be a fully fetched normal (non-diff) query.

  Multiple diffs are possible, just specify the same ParentSearch each time. Also, each diff must be completed before a new one can be created.

• fetchResultIDs

  Returns a number of results (CaseSet and Case ID's) from the specified query, along with an indication of whether there might be more results.

  MaxCases must be 1 or greater. SortOrder is ignored. Direction can be 'asc' (oldest cases first) or 'desc' (newest cases first).

  The first unfetched results in the specified direction will be returned.

• fetchResultSummaries

  Returns a number of results (Case and CaseSet ID's, a summary of the Case details and a list of valid actions) from the specified query, along with an indication of whether there might be more results.

  MaxCases must be 1 or greater. SortOrder is ignored. Direction can be 'asc' (oldest cases first) or 'desc' (newest cases first).

  The first unfetched results in the specified direction will be returned.

  The list of actions refers mainly to methods of the Core Service. Two special actions 'READ' (meaning all get* methods) and 'EDIT' (meaning all add*, update* and remove* methods) exist.

• fetchResultSummariesEx

  Similar to fetchResultSummaries, but also returns some additional details.

• resultCount

  Returns the total number of results for the specified query, and an indication of whether the number is final or not.

  In case the query is still running, the number returned will be the number of result rows found so far.