records

Add Service History Subentry

POST

/api/records/{company_name}/machines/{machine_id}/history/{entry_uid}

curl --request POST \
  --url '/api/records/{company_name}/machines/{machine_id}/history/{entry_uid}' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "report": "Summary of what happened.",
  "status": "diagnosing"
}
'

{
  "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": {},
      "zh": {}

Authorizations

Authorizationstringheaderrequired

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

Path Parameters

entry_uidstringrequired

Required string length: 24 - 24

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

Example: 5eb7cf5a86d9755df3a6c593

machine_idstringrequired

Required string length: 24 - 24

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

Example: 5eb7cf5a86d9755df3a6c593

company_namestringrequired

Body

datestring

reportstringdefault:

statusenum<string>

Available options: diagnosing, repairing, solved

Response

Successful Response

archivedbooleandefault:falserequired

cause_suggestionobject | nullrequired

Show child attributes

completed_suggestionbooleandefault:falserequired

diagnoser_inputobjectrequired

Show child attributes

diagnoser_outputobject | nullrequired

Show child attributes

diagnosis_idstringrequired

Required string length: 24 - 24

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

Example: 5eb7cf5a86d9755df3a6c593

diagnosis_stepsintegerdefault:0required

eventenum<string>required

Available options: malfunction, maintenance, setup

external_linksobject[]default:[]required

Show child attributes

idstringrequired

Required string length: 24 - 24

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

Example: 5eb7cf5a86d9755df3a6c593

machineobjectrequired

Show child attributes

machine_entry_idintegerrequired

machine_uidstringrequired

Required string length: 24 - 24

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

Example: 5eb7cf5a86d9755df3a6c593

owner_namestringrequired

pending_cause_suggestionbooleandefault:falserequired

pending_suggestionbooleandefault:falserequired

pending_symptom_suggestionbooleandefault:falserequired

routineobject | nullrequired

Show child attributes

subentriesobject[]required

Show child attributes

symptom_suggestionsobject[]default:[]required

Show child attributes

titlestring | nullrequired