Using Assets Query Language (AQL) syntax

objectSchema

You can limit the search result to a specific object schema name, e.g. objectSchema = "ITSM Schema".

objectSchemaId

You can limit the search result on object schema ids. e.g. objectSchemaId in (1, 2).

objectType

You can limit the search result to a specific object type name, e.g. objectType = "Employment Start Date".

objectTypeId

You can limit the search result on object type ids. e.g. objectTypeId in (1, 2).

object

You can limit the search to the object, e.g. "object having inboundReferences()" will search all objects having any inbound references to it.

objectId

You can find an object by object Id, e.g. "objectId = 114". Note that the object id is the number from the Key of the object, but without the prefix. E.g. if the Key of your object is ITSM-1111, then the prefix is ITSM and the object id is 1111.

=

Equality test for case insensitive values.

Office = Stockholm

Checks if the Office attribute has a value equal to Stockholm or STOCKHOLM

==

Equality test for case sensitive values.

Office==Stockholm

Checks if the Office attribute has a value equal to Stockholm considering the case of the input provided.

!=

Inequality test

objecttype=Employee and Office!=Stockholm

Checks if the Employee object has an attribute Office whose value is NOT equal to Stockholm.

<

Less than test.

Price < 2000

Checks if the Price is less than 2000 dollars.

>

Greater than test.

Price > 2000

Checks if the Price is greater than 2000 dollars.

<=

Less than or equal to test

Price <= 2000

Checks if the Price is less than or equal to  2000 dollars.

>=

Greater than or equal to test.

Price >= 2000

Checks if the Price is greater than or equal to 2000 dollars.

like

Matches a value with any subset of input in the query. It is case insensitive.

objecttype=Employees and Office like Stock

Returns all objects of Employees type which have an Office attribute value that contains the characters 'Stock' or 'STOCK'

not like

Excludes values which match with any subset of input in the query.

objecttype=Employees and Office not like Stock

Returns all objects of Employees type which have an Office attribute value that DO NOT contain the characters 'Stock'

in()

Finds a match in the given arguments and returns results.

Office in (Stockholm, Oslo, "San Jose")

Returns all objects of Office type which HAVE one of these values: Stockholm, Oslo or San Jose.

not in()

Excludes the results for which a match is found in the given arguments.

Office not in (Stockholm, Oslo, "San Jose")

Returns all objects of Office type which DO NOT HAVE one of these values: Stockholm, Oslo or San Jose.

startswith

Finds a match whose value starts with the given input. It is case insensitive.

Office startsWith St

Returns results which match values of Office type starting with the characters "St" or "ST"

endswith

Finds a match whose value ends with the given input. It is case insensitive.

Office endsWith St

Returns results which match values of Office type ending with the characters "St" or "ST"

is

Helps test whether a value exists or not.

Office is EMPTY

Checks whether the value of the Office type exists and returns results accordingly.

"Office is not EMPTY"

Checks whether the value of the Office type is not empty.

dot operator(.)

Helps navigate the Referenced types attributes for an object.

This operator is commonly used in:

inboundReferences() or inR() functions.

outboundReferences() or outR() functions.

Order by clause.

Country.Office = Stockholm

The dot operator here navigates to the referenced object Office in the attribute Country and compares Office with the value Stockholm.

having

Used with either the inboundReferences() OR outboundReferences() functions

object having inboundReferences()

Returns all objects having inbound references.

not having

Used with either the inboundReferences() OR outboundReferences() functions

object not having inboundReferences()

Excludes all objects having inbound references and returns results.

Date and time

now()
startOfDay()
endOfDay()
startOfWeek()
endOfWeek()
startOfMonth()
endOfMonth()
startOfYear()
endOfYear()

You can use a range of functions to write queries which involve date and time.

We use m for minutes, h for hours, d for days and w for weeks to represent relative time.

e.g. A query with a condition like: Created > "now(-2h 15m)" returns all objects created in the last 2 hours and 15 minutes.

e.g. A query containing something like: objectType = Employees and "Employment End Date" < endOfMonth(-90d)

returns all Employee objects whose Employment End Date falls before 90 days from the current month's end date.

e.g. You may also check for an upcoming date, e.g. check when the license of a software expires by the end of the year. Your query can then include something like : licenseEndDate = endOfYear()

You can use all other date functions in a similar manner.

User

currentUser()

You can filter on user attributes connected to the current (logged in) user by invoking this function in your AQL query. Note that the attribute used in the query for filtering needs to be of type User.

e.g. objecttype = Computer and User = currentUser()

This function will work when a currentUser is selected, ie. the user is logged in.

currentReporter()

You can filter on user attributes connected to current reporter in custom fields by invoking this function in your AQL query. Note that the attribute used in the query for filtering needs to be of type User.

e.g. User = currentReporter()

This function will only work when an issue is selected, and refers to the reporter that appears in the current issue.

user(user1, user2, ..)

You can filter on objects which have a reference to the users that you provide in the argument list of the function. The attribute used to filter must be of User type. 

This function will work with multiple arguments only if the User type attribute that you filter on allows multiple values i.e, the cardinality for it is more than one.

e.g. An object type Team has an attribute Member. This attribute is of User type. Additionally, this attribute has been configured to have a cardinality of 3. If you want to search a set of Team objects where the users: admin and manager are its members, you can write the following query:

objecttype=Team and Member having user("admin", "manager")

Group

group(group1, group2,...)

You can filter on any object connected to a user within a specific group. The attribute used to filter has to be of User type.

e.g. User in group("jira-users", "jira-administrators")

user(user1, user2, ...)

Filter on any object connected to a user within a specific group. The attribute used to filter has to be of Group type.

e.g. Group having user("currentReporter()")

Project

currentProject()

Filter on any object connected to the currently selected Jira project. Works only in the context of a ticket.

e.g. Project = currentProject()

a

• inboundReferences(AQL)

• inR(AQL)

Filter objects having inbound references where the referenced objects match the AQL query provided as an argument to the function.

e.g. An AQL query like: object having inboundReferences() will return all objects having inbound references since the empty AQL argument to the function will match all inbound referenced objects.

But an example query like: object having inboundReferences(Name="John") will return all objects which have an inbound referenced object with an attribute Name and value for Name as "John".

b

• inboundReferences(AQL, referenceTypes)

• inR(AQL, refTypes)

This is a variant of the inboundReferences(AQL) function described in (a)

Using this, you can filter the inbound referenced objects further by providing the Reference Type as a single or multiple value(s). You can do this with the help of the "IN" operator.

Reference Type is the Additional Value field that you provide on an attribute when you define a referenced object for an object type.

e.g. An AQL query like this: object having inR(objectType = "File System", refType IN ("Depends"))

will return objects which have inbound referenced objects of "File System" and only for those File System objects whose Reference Type is "Depends".

Similarly, an AQL query like: object having inR(objectType = "File System", refType IN ("Depends", "Installed", "Using"))

will return objects which have inbound referenced objects of File System and for those File System objects whose Reference Type is any of these: Depends, Installed, Using

c

• outboundReferences(AQL)

• outR(AQL)

Filter objects having outbound references where the referenced objects match the AQL query provided as an argument to the function.

e.g. An AQL query like: object having outboundReferences() will return all objects having outbound references since the empty AQL argument to the function will match all outbound referenced objects.

But an example query like: object having outboundReferences(Name="John") will return all objects which have an outbound referenced object with an attribute Name and value for Name as "John".

d

• outboundReferences(AQL, referenceTypes)

• outR(AQL, refTypes)

This is a variant of the outboundReferences(AQL) function described in (b)

Using this, you can filter the outbound referenced objects further by providing the Reference Type as a single or multiple value(s). You can do this with the help of the "IN" operator.

Reference Type is the Additional Value field that you provide on an attribute when you define a referenced object for an object type.

e.g. An AQL query like this: object having outR(objectType = "Employees", refType IN ("Location"))

will return objects which have outbound referenced objects of Employees and only for those Employees objects whose Reference Type is "Location".

Similarly, an AQL query like: object having outR(objectType = "Employees", refType IN ("Location", "Country"))

will return objects which have outbound referenced objects of Employees and for those Employees objects whose Reference Type is any of these: Location, Country

connectedTickets(JQL query)

Object having tickets connected to them that match given JQL query are returned.

e.g The query: object HAVING connectedTickets(labels is empty)

runs a JQL query (labels is empty) on all connected tickets, and then returns objects based on the results.

objectTypeAndChildren(Name)

Filter objects based on the object type specified by the Name and its children. If the name contains spaces, make sure you enclose it within a pair of double quotes.

objectTypeAndChildren(ID)

Filter objects based on the object type specified by the ID and its children.