Skip to main content
records

Update Symptom Group

Update a symptom group's name, mode and/or replace its member set.

PUT
/api/records/{company_name}/templates/{template_id}/symptom_groups/{group_uid}
Authorizationstringheaderrequired

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

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

Body

application/json
modeenum<string> | null
Available options: multi_select, single_select
nameobject | null

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"]

symptom_uidsstring[] | null

Response

application/json

Successful Response

causesobject[]default:[]required
gradientnumber[][]default:[[]]required
last_updatedstring | nullrequired
likelihoodnumber[][]default:[[]]required
owner_namestringrequired
priorsnumber[]default:[]required
symptom_groupsobject[]default:[]required
symptomsobject[]default:[]required
template_idstringrequired
Required string length: 24 - 24
Pattern: ^[0-9a-f]{24}$
Example: 5eb7cf5a86d9755df3a6c593
userinfoobject | nullrequired