records

Read Template Machine Candidates

Machines on which an entity of this template (a symptom, a routine) can be acted upon: machines built on the template plus chain machines with a node built on it (EPIC-239, operator search picker). Scoped to what the caller may see, like the machine list; share links are not admitted (CurrentUser) — the picker is an in-app flow.

GET

/api/records/{company_name}/templates/{template_id}/machine-candidates

curl --request GET \
  --url '/api/records/{company_name}/templates/{template_id}/machine-candidates?lang=en' \
  --header 'Authorization: Bearer <token>'

[
  {
    "alias": "<string>",
    "class_id": "ChainTemplate",
    "has_overview_image": false,
    "id": "5eb7cf5a86d9755df3a6c593",
    "location": "<string>",
    "name": {
      "bg": {
        "is_auto_translated": true,
        "value": ""
      },
      "cs": {
        "is_auto_translated": true,
        "value": ""
      },
      "da": {
        "is_auto_translated": true,
        "value": ""
      },
      "de": {
        "is_auto_translated": true,
        "value": ""
      },
      "el": {
        "is_auto_translated": true,
        "value": ""
      },
      "en": {
        "is_auto_translated": true,
        "value": ""
      },
      "es": {
        "is_auto_translated": true,
        "value": ""
      },
      "et": {
        "is_auto_translated": true,
        "value": ""
      },
      "fi": {
        "is_auto_translated": true,
        "value": ""
      },
      "fr": {
        "is_auto_translated": true,
        "value": ""
      },
      "hu": {
        "is_auto_translated": true,
        "value": ""
      },
      "id": {
        "is_auto_translated": true,
        "value": ""
      },
      "it": {
        "is_auto_translated": true,
        "value": ""
      },
      "ja": {
        "is_auto_translated": true,
        "value": ""
      },
      "ko": {
        "is_auto_translated": true,
        "value": ""
      },
      "lt": {
        "is_auto_translated": true,
        "value": ""
      },
      "lv": {
        "is_auto_translated": true,
        "value": ""
      },
      "nb": {
        "is_auto_translated": true,
        "value": ""
      },

lang is the caller's UI language, a display preference only (names fall back to English, then to any language), as on the global search: validating it against the company's languages rejected a German UI in an English-only company with a 422, and the picker could not load at all.

Authorizations

Authorizationstringheaderrequired

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

Path Parameters

template_idstringrequired

Required string length: 24 - 24

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

Example: 5eb7cf5a86d9755df3a6c593

company_namestringrequired

Query Parameters

langenum<string> | nullquery

Preferred display language for names

Available options: en, de, fr, es, it, pt, nl, pl, cs, da, sv, fi, nb, et, lt, lv, sk, sl, bg, ru, uk, el, tr, hu, ja, ko, zh, id

Response

Successful Response

itemsobject[]

Show child attributes