Namespace Reference — Modules
Knowledge Base
Curated JQL namespaces and examples for knowledge base.
Knowledge Base namespaces cover article categories and knowledge-base articles used by the KB app and Iris-powered article search.
Key namespaces and models
kb.Categorykb.Article
Common controller intents
learning.Article.irisProcessUserQuerylearning.Article.getArticleslearning.Article.getAntlyArticleslearning.Article.getAntlyArticle
Common model intents
Most listed model namespaces support retrieve, retrieveOne, retrieveV2, create, update/patch, deleteOne, metadata, and aggregate subject to model permissions. Use consequence only for models that implement an on_<consequence> hook.
Retrieve example
json
1{
2 "__meta__": {
3 "schema": "model",
4 "namespace": "kb.Article",
5 "intent": "retrieve",
6 "authenticationClass": "jwt",
7 "ordering": "-created",
8 "limit": 20
9 },
10 "id": null,
11 "created": null
12}Create example
json
1{
2 "__meta__": {
3 "schema": "model",
4 "namespace": "kb.Category",
5 "intent": "create",
6 "authenticationClass": "jwt",
7 "return": {
8 "id": null,
9 "name": null,
10 "alias": null
11 }
12 },
13 "name": "Getting started",
14 "alias": "getting-started"
15}For examples that include foreign keys, numeric ids must refer to records in the same tenant and visible to the authenticated user.