Namespace Reference — Modules

Forum

Curated JQL namespaces and examples for forum.

Forum namespaces cover categories, topics, posts, reactions, subscriptions, user reputation, moderation history, and vector search over community content.

Key namespaces and models

  • forum.Category
  • forum.Topic
  • forum.Post
  • forum.Reaction
  • forum.Subscription
  • forum.UserReputation
  • forum.ModerationHistory

Common controller intents

  • Domain-specific work is primarily model-driven.

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": "forum.Topic", 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": "forum.Category", 5 "intent": "create", 6 "authenticationClass": "jwt", 7 "return": { 8 "id": null, 9 "name": null, 10 "alias": null 11 } 12 }, 13 "name": "General", 14 "alias": "general" 15}

For examples that include foreign keys, numeric ids must refer to records in the same tenant and visible to the authenticated user.