Namespace Reference — Modules

Profiles

Curated JQL namespaces and examples for profiles.

Profiles namespaces cover profile types, profile records, custom profile schema sections/questions, public profiles, current-user profile helpers, and archive operations.

Key namespaces and models

  • profiles.ProfileType
  • profiles.Profile
  • profiles.ProfileSection
  • profiles.ProfileQuestion

Common controller intents

  • profiles.Profile.getOrCreateForCurrentUser
  • profiles.Profile.bulkArchive
  • profiles.Profile.bulkUnarchive
  • profiles.Profile.getCompletionStats
  • profiles.Profile.getPublicProfiles
  • profiles.Profile.saveQuestion
  • profiles.ProfileType.createDefault

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": "profiles.Profile", 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": "profiles.ProfileType", 5 "intent": "create", 6 "authenticationClass": "jwt", 7 "return": { 8 "id": null, 9 "name": null, 10 "alias": null 11 } 12 }, 13 "name": "Vendor", 14 "alias": "vendor" 15}

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