Skip to main content
records

Create Routine

POST
/api/records/{company_name}/templates/{template_id}/routines

Authorizations

Authorizationstringheaderrequired

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

Path Parameters

company_namestringrequired
template_idstringrequired
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:[]
maintenance_intervalobject | null
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"]

routine_typeenum<string>
Available options: composite, basic
stepsobject[]default:[]

Response

application/json

Successful Response

_idstringrequired
Required string length: 24 - 24
Pattern: ^[0-9a-f]{24}$
Example: 5eb7cf5a86d9755df3a6c593
causes_uidsstring[]default:[]required
descriptionobjectrequired
external_idstring | nullrequired
labelsobject[]default:[]required
maintenance_intervalobject | nullrequired
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"]

overview_imageobject | nullrequired
owner_namestringrequired
routine_typeenum<string>required
Available options: composite, basic
stepsobject[]default:[]required
template_idstringrequired
Required string length: 24 - 24
Pattern: ^[0-9a-f]{24}$
Example: 5eb7cf5a86d9755df3a6c593