Use service objects in AQL
Use service objects in AQL
The names you see in Services (for example, Software Registry or Tier) aren't the names you use in Assets Query Language (AQL). Service schemas and attributes use an a_ prefix — so Software Registry becomes a_software_registry, and Tier becomes a_tier. Use the tables in this article to look up the AQL name you need.
Available on Jira Service Management Standard, Premium, and Enterprise plans.
Before you begin
To use service objects in AQL, you need:
A plan that includes services: Standard, Premium, or Enterprise. Not available on Free.
Permission to run AQL queries: the same permissions you need to run any AQL query against an Assets object.
If you're new to AQL, start with Assets Query Language (AQL) first, then come back here to look up service field names.
Why service field names use the a_ prefix
Service schemas and out-of-the-box attributes appear with an a_ prefix in AQL — for example, a_software_registry is the AQL name for the Software Registry schema, and a_tier is the AQL name for the Tier attribute.
The a_ prefix is permanent. It applies to:
The two new service schemas — Software Registry and Business Portfolio
Out-of-the-box attributes within those schemas (listed in this article)
It does not apply to:
Custom attributes you add to a service schema — those keep the names you give them, with no prefix
Custom object types you create — no prefix
Existing schemas you already use in Assets — your existing AQL queries still work as written
If you have been using Assets prior to the new service schemas, you can keep your existing queries as they are. The a_ prefix only applies to the new service schemas and to upcoming schemas in the future. You won't need to refactor any existing queries — the a_ prefix is permanent, so queries you write against a_* fields today will continue to work indefinitely.
Service schema names
There are two new service schemas. Use these AQL names when you want to scope a query to a specific schema.
a_software_registry and a_business_portfolio are schemas, not object types. To query everything inside a schema, scope your query with objectSchema = "<schema name>". To query a specific object type within a schema, use that object type's name instead.
Display name | AQL name |
|---|---|
Software Registry |
|
Business Portfolio |
|
Technical Services |
|
Digital Products |
|
Software Services |
|
Applications |
|
Capabilities |
|
Deployed Services |
|
Business Services |
|
Service attribute names
These are the out-of-the-box attributes on every service object. Use the AQL names below to filter on them, return them, or sort by them.
Display name | AQL name |
|---|---|
Status |
|
Tier |
|
Service ID |
|
Description |
|
Owner team |
|
Responders |
|
Change Approvers |
|
Change Management connected space |
|
Tags |
|
Software Registry references |
|
Business Portfolio references |
|
Example queries
Use objectSchema to scope a query to a specific service schema. Use the attribute names from the table above to filter, return, or sort results. For a full reference of AQL syntax and operators, see Assets Query Language (AQL).
Find all Tier 1 services in the Software Registry schema:
objectSchema = "a_software_registry" AND a_tier = "Tier 1"Find all services owned by a specific team:
a_owner_team = "Platform Team"Find all services missing a Service ID:
a_service_id is EMPTYFind all services in the Business Portfolio schema tagged "customer-facing":
objectSchema = "a_business_portfolio" AND a_tags = "customer-facing"Was this helpful?