Skip to main content

IQL Usage

1. Basics​

  • = 'Type' = 'Story'

  • != 'Type' != 'Story'

  • > 'Numeric Field' > '2'

  • >= 'Numeric Field' >= '2'

  • < 'Numeric Field' < '2'

  • <= 'Numeric Field' <= '2'

  • in 'Type' in ['Story', 'Task', 'Bug']

  • not in 'Type' not in ['Story', 'Task', 'Bug']

  • is 'Assignee' is null 'Assignee' is empty

  • is not 'Assignee' is not null 'Assignee' is not empty

  • ~ 'Title' ~ 'API Automation Scenario'

  • !~ 'Title' !~ 'API Automation Scenario'

  • and 'Type' = 'Story' and 'Assignee' = 'osc-admin'

  • or 'Type' = 'Story' or 'Type' = 'Task'

  • order by order by Created desc

  • key Workspace key query: workspaceKey = 'C20221121'

2. Functions​

  • Current user: currentUser() 'Assignee' in ["currentUser()"]

  • User group: membersOf() 'Assignee' in [membersOf(User Group Name)] 'Assignee' in [membersOf(Team Test Group)]

  • Participant: participant participant = 'osc-admin'

  • Watcher Watcher = 'osc-admin'

  • Query sub-items Parent Item = 'item_key' Parent Item in ['item_key1', 'item_key2']

  • Linked items: linkedItemsOf(iql, Link Description) item in linkedItemsOf('key = "proxima-autotest2-006-41"', Current item can start after the following items are completed)

  • Hierarchical items: hierarchicalQuery(item_key, Up Levels, Down Levels) item in hierarchicalQuery('proxima-autotest2-006-41', 1, 1) Not compatible with key values containing "_".

  • Date-related functions

    • now() Created < now()

    • startOfDay() Created >= startOfDay() and Created <= endOfDay() 'Created' > startOfDay(-3) and 'Created' <= endOfDay() order by Created desc

    • endOfDay()

    • startOfWeek() Created >= startOfWeek() and Created <= endOfWeek() 'Created' >= startOfWeek(-1) and 'Created' <= endOfWeek(-1) and 'Type' in ["Task"] order by Created desc

    • endOfWeek()

    • startOfMonth() Created >= startOfMonth() and Created <= endOfMonth()

    • endOfMonth()

    • startOfYear() Created > startOfYear() and Created < endOfYear()

    • endOfYear()

  • Query status transition user Status Transition User = currentUser()

  • Query status approver (user: supports querying users and users in workspace roles) Pending approval Approver = pendingBy(currentUser()) Approved Approver = approved('osc-admin')

  • User 'Department' in ["currentgroup(Department User Group)"]

  • Sign-in user query Pending sign-in Sign-in User = signBy(currentUser()) Signed in Sign-in User = signedBy(currentUser())

  • Query current handler Current Handler in ['u:username'] Current Handler in ['g:user group name'] Current Handler in ['wr:workspace name:workspace role name'] Current Handler in [currentUser()] Current Handler = currentUser()

  • Query workflow handler Workflow Handler = currentUser() Items with empty workflow handler will not be queried

3. Scenarios​

  • Overdue items Overdue Days > 0 Due Soon Days > 0