JQL Fundamentals
Namespaces
How app.Model, controller, NoSQL, and dynamic object namespaces are resolved.
A JQL namespace is the address of the surface you are querying. Most namespaces use app.Model, for example system.User, tickets.Ticket, or billing.Invoice. Controller namespaces use the same app.Name form but resolve to a NameJqlController class.
Model namespaces
For schema: model, JQL splits namespace on the dot and calls Django's app registry. objects.Record, tasks.Task, tickets.Ticket, billing.Invoice, and module models such as hcm.Employee are all model namespaces.
1{
2 "__meta__": {
3 "schema": "model",
4 "namespace": "tasks.Task",
5 "intent": "retrieve",
6 "authenticationClass": "jwt",
7 "filter": {
8 "status": "pending"
9 },
10 "limit": 20
11 },
12 "id": null,
13 "title": null,
14 "status": null,
15 "dueDate": null
16}Controller namespaces
For schema: controller, namespace: "system.User" resolves to UserJqlController in src.system.controllers. The intent is converted to an on_<intent> method, so verifyAuthentication calls on_verify_authentication.
1{
2 "__meta__": {
3 "schema": "controller",
4 "namespace": "system.User",
5 "intent": "verifyAuthentication",
6 "authenticationClass": "jwt"
7 },
8 "id": null,
9 "email": null,
10 "tenant": {
11 "id": null,
12 "name": null
13 }
14}Dynamic object namespaces
Configured Antly objects are addressed as objects.<ObjectNamespace>. The namespace resolver maps those calls to objects.Record and injects a filter on object.namespace.
1{
2 "__meta__": {
3 "schema": "model",
4 "namespace": "objects.Customer",
5 "intent": "retrieve",
6 "authenticationClass": "jwt",
7 "filter": {
8 "stage": "qualified"
9 },
10 "limit": 10
11 },
12 "id": null,
13 "reference": null,
14 "additionalInformation": null,
15 "created": null
16}Use objects.Object to retrieve the object definition itself and objects.Record when you intentionally want the raw record model. Use objects.<YourObject> when you want records constrained to a particular configured object.
Enabled app families
The API reference pages group namespaces by product surface: system, objects, tasks, tickets, workflow, sites, reports, Iris, notifications, and modules such as HCM, ATS, payroll, finance, inventory, documents, learning, forum, omnichannel, chat, calls, ShopByAntly, and profiles.
See /guides/objects-overview, /guides/roles-permissions, and module namespace pages.