Namespace Reference

Tickets

Curated JQL namespaces and examples for tickets.

Ticket namespaces cover support categories, subcategories, tickets, custom question schema, comments, documents, transactions, pipeline stages, status logs, and ticket workflow nodes.

Key namespaces and models

  • tickets.Category
  • tickets.SubCategory
  • tickets.Ticket
  • tickets.StatusLog
  • tickets.Document
  • tickets.Comment
  • tickets.ExternalComment
  • tickets.Activity
  • tickets.TransactionCategory
  • tickets.Transaction
  • tickets.TransactionLog
  • tickets.Section
  • tickets.Question
  • tickets.Pipeline
  • tickets.PipelineStage
  • tickets.TicketPipelineHistory
  • tickets.Workflow
  • tickets.WorkflowNodeWrapper
  • tickets.WorkflowNode

Common controller intents

  • tickets.Ticket.saveQuestion
  • tickets.Ticket.reorderQuestions
  • tickets.Ticket.updateWorkflowNode
  • tickets.Ticket.getQuickStats
  • tickets.Ticket.getMyQuickStats
  • tickets.Ticket.getMyBadgeCount
  • tickets.Document.upload

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

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