Note: | Whether the search is case-sensitive or case-insensitive depends on how the underlying database (for example, Oracle, DB2, or SQL server) handles the queries that Monitor issues to obtain data. |
serviceName | String Optional. Fully qualified or partial service name on services that you want to retrieve. The serviceNameExact parameter is used with this parameter. | ||
serviceNameExact | String Optional. How to match on the value specified in serviceName. ![]() ![]() | ||
serverID | String Optional. Complete or partial DNS name and port for the Integration Server that ran the service (for example, titan.east.webmethod.com:5555). The serverIDExact parameter is used with this parameter. | ||
serverIDExact | String Optional. How to match on the value specified in serverID. ![]() ![]() | ||
contextID | String Optional. Complete context ID of the services you want to retrieve. | ||
parentContextID | String Optional. Complete context ID of the parent service of the services you want to retrieve. | ||
rootContextID | String Optional. Complete context ID for the root service of the services you want to retrieve. | ||
customContextID | String Optional. The full, user-defined ID for the services that you want to retrieve. User-defined IDs are assigned by executing the pub.flow:setCustomContextID service. Use customContextID to retrieve services based on exact match of the given custom ContextID. | ||
username | String Optional. Integration Server user name of the client that invoked the services that you want to retrieve.
| ||
status | String Optional. Status of the services that you want to retrieve. Use status if you want to retrieves services that all have a single specified status. You can specify either the keyword value for the status or the numerical value that represents the status. For a list of numerical and keyword values, see Status Reference. | ||
statusSet | String List Optional. A set of statuses for the of the services you want to retrieve. Use statusSet when you want retrieve services of more than one specified status. For each status that you specify in statusSet, specify the keyword value for the status or the numerical value that represents the status, as described above for the status parameter. | ||
range | String Optional. The date range for when the most recent log entries for the services you want to retrieved were logged. If you use this parameter, do not use the fromDate or toDate parameter. A week is Sunday through Saturday. ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() | ||
fromDate | Object Optional. The start date of when the most recent log entries of the services you want retrieved were logged. The getList service will get services whose log entries were logged on or after this date. If you use this parameter, use toDate to specify the end date; do not use the range parameter when you use the fromDate and toDate parameters. | ||
toDate | Object Optional. The end date of when the most recent log entries of the services you want retrieved were logged. The getList service will get services whose log entries were logged on or before this date. If you use this parameter, use fromDate to specify the start date; do not use the range parameter when you use the fromDate and toDate parameters. | ||
maxRows | String Optional. Maximum number of services to find, starting with those most recently logged. By default, the service gets all services. | ||
isAnd | String Optional. Whether the service is to use an AND condition or an OR condition for the criteria specified in the input parameters. ![]() ![]() | ||
sortColumn | String How you want the retrieved list of services sorted. This parameter works with the sortAscending parameter. ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() | ||
sortAscending | String Optional.Whether to sort the retrieved lists of services in ascending or descending order. This parameter works with the sortColumn parameter. ![]() ![]() |
services | Document List The retrieved list of services. For each service, the following fields are returned: |
![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |