Diagnostics Search

Semantic ranking signal for the troubleshooting (diagnose) search.

GET

/api/records/{company_name}/diagnostics/search

Diagnostics Search

curl --request GET \
  --url '/api/records/{company_name}/diagnostics/search?permission_object_type=templates&permission_object_id=5eb7cf5a86d9755df3a6c593&q=%3Cstring%3E&limit=20&node_scope=%3Cstring%3E&entity_type=symptom' \
  --header 'Authorization: Bearer <token>'

{
  "hits": [
    {
      "entity_id": "<string>",
      "entity_type": "symptom",
      "score": 123
    }
  ]
}

Context-scoped counterpart of the global search: it authorizes with the exact gate of the diagnostics data endpoints (MACHINE_TEMPLATE_READ on the diagnose context resource, share links included) and returns bare (entity_type, entity_id, score) hits for the symptoms/causes (or, when requested, routines/chain nodes) of that context. The client fuses these scores into its local lexical ranking; ids it does not know locally are dropped.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

company_namestringrequired

Query Parameters

permission_object_typeenum<string>queryrequired

Kind of the diagnose context resource, like the diagnostics data routes

Available options: templates, machines

permission_object_idstringqueryrequired

Id of the diagnose context resource: a machine (incl. chain machines) or a (chain) template — the same object the diagnostics data endpoints authorize on

Required string length: 24 - 24

Pattern: ^[0-9a-f]{24}$

Example: 5eb7cf5a86d9755df3a6c593

qstringqueryrequired

Free-text search query

Required string length: 1 - 500

limitintegerquerydefault:20

Required range: 1 <= x <= 50

node_scopestring[] | nullquery

For chain contexts: restrict to these child template ids. Validated as an intersection with the server-derived children; unknown ids are ignored

entity_typeenum<string>[] | nullquery

Restrict to these entity types (default: symptom + cause, unchanged from before this filter existed). Allowed: ['cause', 'chain_node', 'routine', 'symptom', 'symptom_group'].

Response

Successful Response

hitsobject[]required

Show child attributes