records

Read History Feedback Cause

GET

/api/records/{company_name}/machines/{machine_id}/history/{entry_uid}/malfunction/feedback/causes

curl --request GET \
  --url '/api/records/{company_name}/machines/{machine_id}/history/{entry_uid}/malfunction/feedback/causes' \
  --header 'Authorization: Bearer <token>'

{
  "cause_new": {
    "_id": "5eb7cf5a86d9755df3a6c593",
    "copy_connections_from_uid": "5eb7cf5a86d9755df3a6c593",
    "likelihood": {},
    "object": {
      "description": {
        "en": "The engine is missing oil."
      },
      "name": {
        "en": "Not enough oil"
      },
      "specialists": [
        {
          "en": "Mechanic"
        }
      ],
      "tools": [
        {
          "en": "Wrench"
        }
      ]
    },
    "prior": 123
  },
  "cause_true_uid": "5eb7cf5a86d9755df3a6c593",
  "entry_uid": "5eb7cf5a86d9755df3a6c593",
  "node_id": "5eb7cf5a86d9755df3a6c593",
  "origin": "existing",
  "owner_name": "<string>",
  "reviewed_by": {
    "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>"
  },
  "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

Response

Successful Response

cause_newobject | null

Show child attributes

cause_true_uidstring | null

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

node_idstring | null

Required string length: 24 - 24

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

Example: 5eb7cf5a86d9755df3a6c593

originenum<string>default:existing

Available options: suggested, existing

owner_namestringrequired

reviewed_byobject | null

Who accepted or rejected the suggestion; null while open, and on entries reviewed before this field existed, where userinfo may hold the reviewer.

Show child attributes

search_textstring | null

stateenum<string>

Available options: open, accepted, rejected

userinfoobjectrequired

Who created or last edited the suggestion's content; a reviewer flipping the state never takes this place.

Show child attributes