Table of Contents
Advertisement
Request Parameters
The following table lists the parameters accepted by the Key Query interface.
The
queryFilter
query parameters are too complex to describe in the parameter table. Details about
valid parameters and values for query filters are in a separate table following the
parameters.
Table 6-18 Parameters Accepted by the Key Query Interface
Parameter
maxCount
op
queryFilter
querySentinel
parameter must be a valid query filter. The syntax and valid
Format and Description
number
Specifies the maximum number of keys to display on each page returned. If
more than maxCount keys match the search criteria, each page will have
controls to see the next or previous page of results.
queryKey
The only operation supported by the List Certificates interface is queryKey.
([<OP>]<FILTER>[<FILTER>...])
Details about building query filters are provided in the next table.
The queryFilter must be enclosed in parentheses.
The <OP> argument, required if there is more than one <FILTER>, specifies
how the filters that follow should be logically evaluated:
• & (ampersand) means that the filters should be linked by a logical AND: all
filters must evaluate to true for the expression to match a key.
• | (pipe) means that the filters should be linked by a logical OR: if at least
one filter evaluates to true, the expression matches a key.
Any number of filters can be concatenated within any set of parentheses.
An example filter is
(|(keyArchivedBy=drmagent1)(&(keySerialNumber>=5)(keySeria
lNumber<=35)))
This filter matches any key that was archived by drmagent1 or keys with serial
numbers between 5 and 35 in the archive.
number
The querySentinel indicates which record out of the total matching set
should be the first displayed on the resulting output page. For example, if
totalRecordCount = 15 and maxCount = 5, set querySentinel to 6 to
show the 6th through 10th element of the matching set.
Key Query Interface
Chapter 6
Agent Interface Reference
129
Advertisement
Table of Contents
