IBM Maximo Asset Management Multitenancy 7.6

REST query parameters

By using query parameters, you can tailor and filter the responses.

You can specify one or more of the following query parameters to control the data that is selected. Boolean values must be set to 1 for true or 0 for false.

Table 1. REST query parameters
Name	Type or value	Description	Default
_compact	Boolean	If true, JSON data is represented in a compact representation.	False
_dropnulls	Boolean	If true, attributes are serialized only if the business object or object structure resource has a value. If false, all attributes are serialized, even if they are null.	True
_exactmatch	Boolean	If true, parameter values are evaluated for an exact match. If false, a LIKE evaluation occurs.	False
_excludecols	Comma-separated list of MBO attributes	Excludes the listed attributes from the resource response. Valid only for the business object resource type.
_fd		Specifies an application table domain to apply as a filter when the query is run. Can be used with the _fdorg and _fdsite parameters.
_fdorg		Specifies an organization ID to apply as a filter when the query is run. Must be used with the _fd parameter.
_fdsite		Specifies a site ID to apply as a filter when the query is run. Must be used with the _fd parameter.
_format	json or xml	Specifies the representation of the resource response.	xml
_generic	Boolean	If true, the resource response field data is returned in a generic format. Applies to JSON data only.	False
_glc	Boolean	If true, the general ledger (GL) component data is included for all Chart of Accounts application fields of the business object. For most Chart of Accounts fields, the individual component data is included. This parameter by default omits the component data and therefore might improve performance.	False
_includecols	Comma-separated list of MBO attributes	Specifies the attributes that are included as part of the resource response. Valid only for the business object resource type.
_keys	Boolean	If true, only the key attributes of the business object are serialized. All other attributes are dropped from the resource response.	False
_lang		Specifies the language code of the requester. If this parameter is not specified, the accept-language parameter of the HTTP header is used to determine the language preference of the requester. If the HTTP header does not specify the parameter, the value from the default integration user is used.
_lid and _lpwd		Specifies a login user ID and password. For development and testing use only. Valid only when native authentication is configured.
_locale	Boolean	If true, the locale-specific text version of the business object attribute value is returned in addition to the strong typed value.	False
_maxItems	Numeric	Specifies the maximum number of business objects that are serialized in the resource collection. Use this parameter with the _rsStart parameter to page the response for large resource collections. The parameter name is case-sensitive.
_md	Boolean	If true, metadata information, such as hidden, read-only, and required values, are returned.	False
_opmodeor	Boolean	If true, the OR operator is applied between multiple attribute parameters. If false, the AND operator is applied.	False
_orderby		Specifies how the fields of a resource are ordered. The value can be `asc` (ascending) or `desc` (descending). For an object structure resource, this parameter can be used only for the fields of business objects that are at the first or second level of the object structure.
_orderbyasc	Comma-separated list of MBO attributes	Specifies the attributes that are used for the order by clause in ascending order.
_orderbydesc	Comma-separated list of MBO attributes	Specifies the attributes that are used for the order by clause in descending order.
_page		Specifies the page number that the request must return. This parameter can be used only if a pagesize system property is created for the resource that is being queried.
_qop		Specifies a query method for the GET operation. Valid for MBO resources only.
_rcol.`alias`		Specifies a relationship name field that is returned as part of the query response. The `alias` is the alias name for the related attribute. By specifying this parameter, you can query fields that are related to the MBO resource that is queried. For example, in the parameter _rcol.polinecost=poline.linecost, polinecost is the alias name and poline.linecost is the related attribute.
_retainmbos	Boolean	For internal use only.
_rlid	Boolean	Specifies the ID of a resource collection. This parameter is used only for in-session scrolling.
_rlrq	Boolean	If true, the cache is released for the resource collection that is specified by the _rlid parameter.	False
_rootonly	Boolean	If true, only the main object of the object structure is serialized. Valid only for the object structure resource type.	False
_rowstamp		For update requests, the rowstamp business object can be provided to ensure that the object that is being updated has not changed since it was first queried.
_rsStart	Numeric	Specifies the start index of the MBO in the resource collection that is serialized by the resource response. The parameter name is case-sensitive.	0
_tc	Boolean	If true, the total number of records is calculated and that number is assigned to the rsTotal attribute. The calculation adds to the processing time, depending on the size of the resource collection.	False
_tenantcode	ALN	Specifies the tenant database area that is the target of a query. This parameter is required only when a query is issued by a consultant that can access the database areas of more than one tenant.
_tz		Specifies the time zone of the request. Use this parameter to correctly run date-related queries when the time zone of the request is different from the time zone of the application.
_ulcr	Boolean	If true, a POST method returns a link to the new resource in the HTTP header Location property.	False
_urs	Boolean	If true, a query response includes the rowstamp value for the resource.
_usc	Boolean	If true, in-session scrolling is used and the HTTP response includes the resource collection ID by using the _rlid property.	False
_uw		Specifies an SQL WHERE clause to be used as the selection criteria. The clause must be compatible with a clause that works in advanced searches in applications. Use with the mxe.rest.whereclause.usepolicy system property.
_verbose	Boolean	If true, the resource response for JSON representation is returned as formatted.	False
_vt	Boolean	If true, the XML is validated for valid XML characters. If you set the parameter to false, no validation is run and therefore performance might improve. If this parameter is not specified, the mxe.int.validatexml system property determines whether XML is validated.	True

Feedback