Namespace Reference — Modules

Assets

Curated JQL namespaces and examples for assets.

Assets namespaces cover asset categories, locations, assets, transactions, depreciation, meters, readings, maintenance plans, work orders, and custom asset/work-order schema.

Key namespaces and models

  • assets.AssetCategory
  • assets.AssetLocation
  • assets.Asset
  • assets.AssetTransaction
  • assets.AssetDepreciationRun
  • assets.AssetMeter
  • assets.AssetMeterReading
  • assets.MaintenancePlan
  • assets.WorkOrder
  • assets.AssetSection
  • assets.AssetQuestion
  • assets.WorkOrderType
  • assets.WorkOrderSection
  • assets.WorkOrderQuestion

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": "assets.Asset", 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": "assets.AssetCategory", 5 "intent": "create", 6 "authenticationClass": "jwt", 7 "return": { 8 "id": null, 9 "name": null, 10 "alias": null 11 } 12 }, 13 "name": "Laptop", 14 "alias": "laptop" 15}

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