API V3 Documentation – NAV
Preview: this documents PQFORCE 4.26.6, which has not been released yet.
Endpoints
POST /API/V3/NAV/Search
Full text search over all objects of all types known to the navigation. Returns the found objects together with their parent.
HTTP syntax
POST /API/V3/NAV/Search?query=...&sort=...
<- application/json JavaScript syntax
Pqf.nav.search(query, sort) // returns PF.ReferenceWithParent[]
// Overloads for optional parameters
Pqf.nav.search(query) // returns PF.ReferenceWithParent[]Required permission
The returned array is filtered and contains only objects with permission IDENTIFY.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
query |
string | The full text search query (mandatory), may contain HTML which is decoded before searching | ✔️ | non-null & matches '.{1,255}' (The value is required and must be a single line of 1 to 255 characters.) |
sort |
array of string | Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".) |
Result
This endpoint returns the following data: array of PF.ReferenceWithParent