PingDirectory API Reference

Matching entry count response control

This control may be included in a search result in response to a matching entry count request control, and it includes the results of the matching entry count processing. The control has an OID of 1.3.6.1.4.1.30221.2.5.37, and it takes a value. The following fields may be present in the value-json representation of the value:

  • count-type: A string field whose value will be used to indicate how accurate the entry count is. The value may be one of the following:

    • examined-count: Indicates that the provided entry count is known to accurately represent the number of matching entries that would actually be returned to the client.

    • unexamined-count: Indicates that the provided entry count is known to accurately represent the number of matching entries, but that those entries were not examined to verify that they would all actually have been returned to the client in the course of processing a normal search (for example, because the client didn’t have permission to see them, or because they are special types of entries like LDAP subentries that aren’t normally returned).

    • upper-bound: Indicates that the provided entry count represents the maximum number of entries that may match the search criteria, but that the actual matching entry count could be lower.

    • unknown: Indicates that the server was unable to provide any kind of estimate for the number of entries matching the search criteria.

  • count-value: An optional integer field that represents the entry count estimate determined by the server. This will be present for count-type values of examined-count, unexamined-count, and upper-bound, but will be absent for a count-type value of unknown.

  • search-indexed: A Boolean field that indicates whether the server considers the search to be at least partially indexed.

  • fully-indexed: An optional Boolean field that indicates whether the server considers the search to be fully indexed. This will only be present if extended response information was requested.

  • short-circuited: An optional Boolean field that indicates whether the server short-circuited at any point in evaluating the search criteria. This will only be present if extended response information was requested.

  • candidates-are-in-scope: An optional Boolean field that indicates whether the server knows that all candidate entries are within the scope of the search. This will only be present if extended response information was requested.

  • remaining-filter: An optional string field whose value is the portion of the provided search filter that was not evaluated during the course of coming up with the estimate. This will only be present if extended response information was requested and a remaining filter is available.

  • debug-info: An optional array field whose values are strings providing debug messages generated by the server in the course of determining the estimated number of matching entries. This will only be present if debug information was requested.

The following represents an example JSON encoding for the control:

{ "oid":"1.3.6.1.4.1.30221.2.5.37",
  "control-name":"Matching Entry Count Response Control",
  "criticality":false,
  "value-json":{ "count-type":"unexamined-count",
                 "count-value":1,
                 "search-indexed":true,
                 "debug-info":[ "Sample debug message 1",
                                "Sample debug message 2" ] } }