Skip to main content
records

Add History Suggested Symptom

POST
/api/records/{company_name}/machines/{machine_id}/history/{entry_uid}/malfunction/feedback/symptoms
Authorizationstringheaderrequired

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

company_namestringrequired
machine_idstringrequired
Required string length: 24 - 24
Pattern: ^[0-9a-f]{24}$
Example: 5eb7cf5a86d9755df3a6c593
entry_uidstringrequired
Required string length: 24 - 24
Pattern: ^[0-9a-f]{24}$
Example: 5eb7cf5a86d9755df3a6c593

Body

application/json
descriptionobject
external_idstring | null
Pattern: ^[a-zA-Z0-9_-]*$
labelsobject[]default:[]
nameobjectrequired

Localized string, atleast one language must be set to is_auto_translated: False if any value is set

localized_str = LocalizedStr(en={"value":"hello", "is_auto_translated": False}) localized_str LocalizedStr(en='hello') set(Locals).issubset(LocalizedStr.model_fields.keys()) True #text set but every language is auto-translated -> invalid try: ... LocalizedStr(en={"value": "hello", "is_auto_translated": True}) ... except ValidationError as e: ... assert e.errors()[0]["msg"] == "Value error, If there are texts set, is auto translated must be set for atleast one of them", e.errors()[0]["msg"] #text on an earlier language, empty on a later one, both auto-translated -> still invalid try: ... LocalizedStr(en={"value": "hello", "is_auto_translated": True}, de={"value": "", "is_auto_translated": True}) ... except ValidationError as e: ... assert e.errors()[0]["msg"] == "Value error, If there are texts set, is auto translated must be set for atleast one of them", e.errors()[0]["msg"]

node_idstring | null
Required string length: 24 - 24
Pattern: ^[0-9a-f]{24}$
Example: 5eb7cf5a86d9755df3a6c593
rankstringdefault:
reviewstatusstringdefault:
search_textstring | null
specialistsobject[]default:[]
toolsobject[]default:[]

Response

application/json

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

owner_namestringrequired
search_textstring | null
stateenum<string>required
Available options: open, accepted, rejected
userinfoobjectrequired