records

Handle Suggested Symptom

PUT

/api/records/{company_name}/machines/{machine_id}/history/{entry_uid}/malfunction/feedback/symptoms/{symptom_uid}/state

curl --request PUT \
  --url '/api/records/{company_name}/machines/{machine_id}/history/{entry_uid}/malfunction/feedback/symptoms/{symptom_uid}/state' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cause_uids": [],
  "group_uid": "5eb7cf5a86d9755df3a6c593",
  "rating": "diagnosis",
  "state": "open"
}
'

{
  "id": "5eb7cf5a86d9755df3a6c593",
  "object": {
    "description": {
      "en": "The engine suddenly stopped running."
    },
    "name": {
      "en": "Engine standstill"
    },
    "specialists": [
      {
        "en": "Mechanic"
      }
    ],
    "tools": [
      {
        "en": "Wrench"
      }
    ]
  },
  "owner_name": "<string>",
  "search_text": "<string>",
  "state": "open",
  "userinfo": {
    "company": [
      "<string>"
    ],
    "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": {
      "id": "5eb7cf5a86d9755df3a6c593",
      "owner_name": "<string>",
      "public_id": "<string>",
      "resource_id": "5eb7cf5a86d9755df3a6c593",
      "resource_type": "machines"
    },
    "sub": "<string>"
  }
}

Authorizations

Authorizationstringheaderrequired

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

Path Parameters

company_namestringrequired

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

symptom_uidstringrequired

Required string length: 24 - 24

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

Example: 5eb7cf5a86d9755df3a6c593

Body

cause_uidsstring[]default:[]

group_uidstring | null

Required string length: 24 - 24

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

Example: 5eb7cf5a86d9755df3a6c593

ratingenum<string>default:diagnosis

How an accepted symptom is rated when the entry has no confirmed cause.

Available options: diagnosis, unrated, causes

stateenum<string>required

Available options: open, accepted, rejected

Response

Successful Response

idstring

Required string length: 24 - 24

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

Example: 5eb7cf5a86d9755df3a6c593

objectobjectrequired

Used for all occurence where we save a symptom create directly e.g. in the suggestion

Show child attributes

owner_namestringrequired

search_textstring | null

stateenum<string>required

Available options: open, accepted, rejected

userinfoobjectrequired

Show child attributes