Filtering

The most common way to filter a resource set is to use the oslc.where query parameter. This parameter internally maps to the Maximo QBE framework. You can filter data that is based on all persistent attributes, at the main MBO (for the OS) or any related MBO. In the example, the where clause filters assets that are based on locations and the asset status.

The locations MBO is not part of the MXAPIASSET object structure. The format for the dot notation (location.status) is <rel1>[.rel2]*.attr1. As you can make out, the dot notation can be nested. The leaf element is always an attribute in the target Mbo.

The following table describes the different operators that you can use for filtering data:

This query language is data type sensitive and the double quotes "" is used for character based attributes and for dates (ISO Format). Numeric values are represented in their corresponding ISO formats (that is non localized format). Boolean values are always represented either as 1/0 or true/false (no quotes).

You can use the in clause with numeric values too.

For the LIKE clause, you can use the following variations:

If you want to use starts with:

If you want to use ends with:

To use null value queries, you can use the star (*) notation. For example, a not null check is completed by using the following format where - status is not null.

If you want to use the is null check:

If you want to use a not in clause, you can use the following format:

Note that this not in clause currently only works for ALN attributes.

Range filters are used to support range based queries. For example, if you want to only get assets within a certain date range and priority range, you can use this feature.

You can also filter with date ranges by using timeline queries.

You can also filter by using the internal values for synonymdomains. The following example shows how you can filter the work order objects that are based on the internal values for the status attribute (bound to the WOSTATUS synonymdomain).

This will filter the work order collection using the not in clause for the set of external values that correspond to the internal values of APPR and INPRG. We can use a in comparison by changing the expression like below:

There are a few things to note:

You can also filter using the maxtabledomain list WHERE clause. The maxtabledomain is more useful for backward compatibility reasons with the older rest API and also in case a client wants to use an existing list WHERE clause that was created by using the table-domain. The API syntax is shown:

This API picks up the domain’s listwhere and applies that to the collection. The site and organization are optional and needed if the maxtabledomain is site/org scoped.

The timeline filters allow a simpler way to filter collections with time range based queries. The following example shows how you can list all work orders reported in the past three months:

This query finds all the work orders with a reportdate between today and the previous three months. The query is by default indexed around the current date. Another variation of this query is to range on a future date by switching the sign on the tlrange to say +3M instead of -3M. For reportdate a future date range may not be good use case, but it would for date attributes like scheduled date that can be in the future. You might also use the current date as an index and filter around that date using the +- notation as shown in the following example:

This query filters records from three years in the past and three years in the future that is indexed on the current date. If you do not want to index on the current date, you can specify the date that you want to use for the index. The following example shows how you can specify the date:

Maximo objects, such as assets, locations, items, and work orders can be associated with classifications to provides a way to associate classification metadata (aka classification attributes) to the objects. These objects (assets,locations etc) are searched for based on those attribute values. This search capability is known as the attribute search feature. The following example shows an attributesearch that is applied to the asset MBO by using the MXAPIASSET object structure.

All assets that have a class spec attribute called SPEED with a value >=50 are searched for. If the value :>=50 is not defined, then assets that have SPEED as a specific attribute is returned.

It would have only fetched assets that have SPEED as a spec attribute. To combine multiple attributes in the search, you can use the following example:

This query searches for assets that have a class spec attribute SPEED with a value that is greater than 50, an attribute named AREA, and attribute name ELEV with a value of 300, all ANDed together.

This feature is in addition to the oslc.where/savedquery query parameter. So you can use this feature along with the other filtering capabilities that are supported in this API framework.