staff.navigation

1 method on staff.navigation. Each returns the answer's data and throws NoviqaError on a failed answer.

retrieve

GET/admin/v1/navigation

The caller's navigator

The module tree of the admin or manager terminal, holding only the modules the caller's rights open (a folder with nothing to open is left out). Each node says whether the caller may view and edit it. The Groups node holds the tree of groups in the caller's group scope, the Symbols node the tree of symbol folders; their nodes carry path and count (groups at or under the node; symbols in the folder). Any signed-in staff member may call it.

Parameters

terminalstring · query

Which terminal's navigator; default admin.

admin manager

Returns

Promise<docSystemNavigation>

The answer's data.

Errors

400invalid_input: invalid input

401auth.session_expired: session expired, sign in again

403auth.invalid_terminal: this terminal cannot be used here

403auth.otp_enrol_required: your group requires one-time codes: set them up to continue

403auth.password_change_required: you must change your password first

500internal: something went wrong

SDKcURL

import { staff } from "@/lib/noviqa"

const data = await staff.navigation.retrieve({
  terminal: "admin"
})

bash

curl -X GET "$NOVIQA_API_URL/admin/v1/navigation?terminal=admin" \
  -H "Authorization: Bearer $NOVIQA_TOKEN"

Response 200

json

{
  "success": true,
  "code": "ok",
  "message": "done",
  "data": {
    "nodes": [
      {
        "can_edit": true,
        "can_view": true,
        "children": [
          {}
        ],
        "count": 1,
        "id": "string",
        "label": "string",
        "module_key": "string",
        "path": "real\\standard",
        "route": "string"
      }
    ]
  },
  "request_id": "5b7f2c1e"
}

staff.navigation.retrieve(query?: { terminal? }, options?: RequestOptions): Promise<http.docSystemNavigation>

staff.navigation ​

retrieve ​

retrieve