Note: | Whether the search is case-sensitive depends on how the underlying database (for example, Oracle, DB2, or SQL server) handles the queries that Monitor issues to obtain data. |
documentID | String Optional. A complete or partial document ID of the documents you want in the list. | ||
type | String Optional. The document type to list. Use type if you want the list to contain all documents of one document type. You can specify either a keyword (for example, Broker) or a numerical value that represents the type (for example, 0). Use the value that corresponds to the type of document you want to retrieve. ![]() ![]() ![]() ![]() | ||
typeSet | String List Optional. A set of document types to retrieve. Use typeSet when you want the list to contain documents of more than one type. For each document type, you can specify either a keyword (for example, Broker) or a numerical value that represents the type (for example, 0). Valid values are: ![]() ![]() ![]() ![]() | ||
documentName | String Optional. A complete or partial document name on which to match. This works with the documentNameExact parameter. | ||
documentNameExact | String Optional. Whether the service should perform an exact match on the document name you specify in documentName. ![]() ![]() | ||
clientID | String Optional. A complete or partial client ID to match. This parameter works with the clientIDExact parameter. Supply the client ID that matches the document type you want to retrieve: ![]() ![]() ![]() ![]()
The format for Broker IDs is Broker@host:port (for example, CustOps@qatest07:6849). The format for IDs of Broker clients is clientprefix_folder1.folder2.foldern_trigger (for example, joesmith_documents.history.triggers_MsgHistoryTrigger). | ||
clientIDExact | String Optional. Whether the service should perform an exact match on the client ID you specify in clientID. Valid values are: ![]() ![]() | ||
range | String Optional. A date range for the documents you want in the list. The date range identifies the date when the documents were logged. If you use this parameter, do not use the fromDate or toDate parameter. A week is Sunday through Saturday. | ||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() | |||
fromDate | String Optional. The start date of when the documents were logged. The service will get all documents logged on or after this date. Use the format YYYY-MM-DD HH:MM:SS. If you use this parameter, use toDate to specify an end date; do not use the range parameter when you use the fromDate and toDate parameters. | ||
toDate | String Optional. The end date of when the documents were logged. The service will get all documents logged on or before this date. Use the format YYYY-MM-DD HH:MM:SS. | ||
maxRows | String Optional. Maximum number of documents to find, starting with those most recently logged. By default, the service gets all documents. | ||
sortColumn | String Optional. How to sort the returned list of documents. This parameter works with the sortAscending parameter. | ||
![]() ![]() | |||
![]() ![]() ![]() ![]() ![]() | |||
![]() ![]() ![]() | |||
sortAscending | String Optional. Whether to sort the returned list of documents in ascending or descending order. The documents are sorted by the field identified by the sortColumn parameter. ![]() ![]() | ||
isAnd | String Optional. Whether the service is to use an AND or an OR condition for the criteria specified in the input parameters. ![]() ![]() |
documents | Document List List of documents that match the specified criteria. For each document, the following fields are returned: |
![]() ![]() | |
![]() ![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |