Administering and Monitoring Business Processes 10.4 | Administering and Monitoring Business Processes | webMethods Monitor Built-in Services Reference | pub.monitor.service Folder | pub.monitor.service:getList
 
pub.monitor.service:getList
Retrieves a list of services whose most recent log entry (that is, current state) matches specified criteria.
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.
Input Parameters
The following table lists the input parameters.
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.
*true Exactly match the serviceName parameter.
*false Default. Contains a substring that matches the serviceName parameter.
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.
*true   Exactly matches the serverID parameter.
*false Default. Contains a substring that matches the serverID parameter.
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.
Note: Whether Monitor treats username as 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.
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.
*Today Today
*Yesterday Yesterday
*In the last 7 days Within the last 7 days, including today.
*Last week Any day in the last calendar week.
*This week Any day in this calendar week.
*Last month Any day in the last calendar month.
*This month Any day in the current calendar month.
*Year to date Any day in the current calendar year.
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.
*true  Use an AND condition. Services that match all the criteria you specify are returned. This is the default.
*false Use an OR condition. Services that match any of the criteria you specify are returned.
sortColumn
String How you want the retrieved list of services sorted. This parameter works with the sortAscending parameter.
*ROOTCONTEXTID Root context ID
*PARENTCONTEXTID Parent context ID
*CONTEXTID Context ID
*SERVICENAME Service name
*STATUS Status
*USERID Integration Server client that invoked the service.
*SERVERID Integration Server that ran the service.
*AUDITTIMESTAMP Default. Time the most recent log entry was logged.
sortAscending
String Optional.Whether to sort the retrieved lists of services in ascending or descending order. This parameter works with the sortColumn parameter.
*true   Default. Sort in ascending order.
*false Sort in descending order.
Output Parameters
The following table lists the output parameters.
services
Document List The retrieved list of services. For each service, the following fields are returned:
*ROOTCONTEXTID String Root context ID of the service.
*PARENTCONTEXTID String Context ID of the service's parent service.
*CONTEXTID String Context ID of the service.
*SERVICENAME String Name of the service.
*SERVERID String Integration Server on which the service ran.
*USERID String Integration Server user name of the client that invoked the service.
*FIRSTSTATUS Number First status of the process instance.
*FIRSTSTATUSDECODE String Status value of the first status of the service. The getList service returns the keyword value that represents the status. For the list of keyword values, for example, “Started” or “Completed,” see Status Reference.
*FIRSTTIME Number Time that data was last logged for the process instance, in epoch time; that is, the number of seconds since January 1, 1970.
*FIRSTTIMESTRING String Time that data was first logged for the process instance, in string format, YYYY-MM-DD hh:mm:ss.SSS zzz, where: YYYY-MM-DD is the date, hh:mm:ss:SSS is the time and zzz is the time in milliseconds.
*LASTSTATUS Number Last status of the process instance.
*LASTSTATUSDECODE String Status value of the last status of the service. The getList service returns the keyword value that represents the status. For the list of keyword values, for example, “Started” or “Completed,” see Status Reference.
*LASTTIME Number Time that data was last logged for the process instance, in epoch time; that is, the number of seconds since January 1, 1970.
*LASTTIMESTRING String Time that data was last logged for the process instance, in string format, YYYY-MM-DD hh:mm:ss.SSS zzz, where: YYYY-MM-DD is the date, hh:mm:ss:SSS is the time and zzz is the time in milliseconds.
*DURATION String If the service's status is 2 (Completed) or 4 (Failed), the length of time the service ran (in milliseconds).
*RESUBMITTABLE String Whether the service is resubmittable.
*true   Service is resubmittable.
*false Service is not resubmittable.
Copyright © 2019 | Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.
Innovation Release