records

Read Step

GET

/api/records/{company_name}/templates/{template_id}/routines/{routine_uid}/steps/{step_uid}

Read Step

curl --request GET \
  --url '/api/records/{company_name}/templates/{template_id}/routines/{routine_uid}/steps/{step_uid}' \
  --header 'Authorization: Bearer <token>'

{
  "id": "5eb7cf5a86d9755df3a6c593",
  "owner_name": "<string>",
  "routine": {
    "_id": "5eb7cf5a86d9755df3a6c593",
    "causes_uids": [],
    "description": {},
    "external_id": "<string>",
    "labels": [],
    "maintenance_interval": {},
    "name": {},
    "overview_image": {},
    "owner_name": "<string>",
    "routine_type": "composite",
    "steps": [],
    "template_id": "5eb7cf5a86d9755df3a6c593"
  },
  "routine_id": "5eb7cf5a86d9755df3a6c593",
  "task": {
    "description": {},
    "duration": "<string>",
    "name": {},
    "notices": [],
    "safety_equipment": [],
    "specialists": [],
    "tools": [],
    "uid": "5eb7cf5a86d9755df3a6c593"
  }
}

Authorizations

Authorizationstringheaderrequired

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

Path Parameters

company_namestringrequired

routine_uidstringrequired

Required string length: 24 - 24

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

Example: 5eb7cf5a86d9755df3a6c593

template_idstringrequired

Required string length: 24 - 24

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

Example: 5eb7cf5a86d9755df3a6c593

step_uidstringrequired

Required string length: 24 - 24

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

Example: 5eb7cf5a86d9755df3a6c593

Response

Successful Response

idstring | nullrequired

Required string length: 24 - 24

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

Example: 5eb7cf5a86d9755df3a6c593

owner_namestringrequired

routineobject | nullrequired

Show child attributes

routine_idstring | nullrequired

Currently being used to reconcile both BE and RxDB Data in FE

Required string length: 24 - 24

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

Example: 5eb7cf5a86d9755df3a6c593

taskobject | nullrequired

Show child attributes