records

Read Machine Service History

GET

/api/records/{company_name}/machines/{machine_uid}/history

curl --request GET \
  --url '/api/records/{company_name}/machines/{machine_uid}/history?order_by=name&order=asc&archived=true&pending_malfunction=true&machine__template_id=5eb7cf5a86d9755df3a6c593&cause_suggestion__state=open&diagnosis_id=5eb7cf5a86d9755df3a6c593&completed_suggestion=true&pending_suggestion=true&pending_cause_suggestion=true&pending_symptom_suggestion=true&limit=123&offset=123' \
  --header 'Authorization: Bearer <token>'

[
  {
    "archived": false,
    "cause_suggestion": {
      "cause_new": {},
      "cause_true_uid": "5eb7cf5a86d9755df3a6c593",
      "node_id": "5eb7cf5a86d9755df3a6c593",
      "origin": "existing",
      "reviewed_by": {},
      "search_text": "<string>",
      "state": "open",
      "userinfo": {
        "company": [],
        "email": "jsmith@example.com",
        "email_verified": false,
        "family_name": "<string>",
        "given_name": "<string>",
        "is_share_link": false,
        "is_superadmin": false,
        "name": "<string>",
        "preferred_username": "<string>",
        "share_link": {},
        "sub": "<string>"
      }
    },
    "completed_suggestion": false,
    "diagnoser_input": {
      "excluded_causes": [],
      "excluded_symptoms": [],
      "overwritten_causes": [],
      "selected_symptoms": []
    },
    "diagnoser_output": {
      "causes": [
        {}
      ],
      "done": true,
      "progress": 123,
      "symptoms": [
        {}
      ]
    },
    "diagnosis_id": "5eb7cf5a86d9755df3a6c593",
    "diagnosis_steps": 0,
    "event": "malfunction",
    "external_links": [],
    "id": "5eb7cf5a86d9755df3a6c593",
    "machine": {
      "alias": "<string>",
      "class_id": "ChainTemplate",
      "id": "5eb7cf5a86d9755df3a6c593",
      "name": {
        "bg": {},
        "cs": {},
        "da": {},
        "de": {},
        "el": {},
        "en": {},
        "es": {},
        "et": {},
        "fi": {},
        "fr": {},
        "hu": {},
        "id": {},
        "it": {},
        "ja": {},
        "ko": {},
        "lt": {},
        "lv": {},
        "nb": {},
        "nl": {},
        "pl": {},
        "pt": {},
        "ru": {},
        "sk": {},
        "sl": {},
        "sv": {},
        "tr": {},
        "type": "html",
        "uk": {},

Authorizations

Authorizationstringheaderrequired

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

Path Parameters

machine_uidstringrequired

Required string length: 24 - 24

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

Example: 5eb7cf5a86d9755df3a6c593

company_namestringrequired

Query Parameters

order_byenum<string> | nullquery

Available options: name, owner_name, _id

orderenum<string>querydefault:asc

Available options: desc, asc

archivedboolean | nullquery

pending_malfunctionboolean | nullquery

machine__template_idstring | nullquery

Required string length: 24 - 24

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

Example: 5eb7cf5a86d9755df3a6c593

cause_suggestion__stateenum<string> | nullquery

Available options: open, accepted, rejected

diagnosis_idstring | nullquery

Required string length: 24 - 24

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

Example: 5eb7cf5a86d9755df3a6c593

completed_suggestionboolean | nullquery

pending_suggestionboolean | nullquery

pending_cause_suggestionboolean | nullquery

pending_symptom_suggestionboolean | nullquery

limitinteger | nullquery

Required range: 0 <= x

offsetinteger | nullquery

Required range: 0 <= x

Response

Successful Response

itemsobject[]

Show child attributes