records

Add Causes Batch

Add many causes in one request. Batch of the single add-cause endpoint.

POST

/api/records/{company_name}/templates/{template_id}/diagnostics/causes/batch

Add Causes Batch

curl --request POST \
  --url '/api/records/{company_name}/templates/{template_id}/diagnostics/causes/batch' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "_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
  }
]
'

{
  "causes": [],
  "gradient": [
    []
  ],
  "last_updated": "2023-11-07T05:31:56Z",
  "likelihood": [
    []
  ],
  "owner_name": "<string>",
  "priors": [],
  "symptom_groups": [],
  "symptoms": [],
  "template_id": "5eb7cf5a86d9755df3a6c593",
  "userinfo": {
    "company": [],
    "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": {},
    "sub": "<string>",
    "used_inference": false
  }
}

Authorizations

Authorizationstringheaderrequired

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

Path Parameters

template_idstringrequired

Required string length: 24 - 24

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

Example: 5eb7cf5a86d9755df3a6c593

company_namestringrequired

Body

itemsobject[]

Minimum array length: 1

Show child attributes

Response

Successful Response

causesobject[]default:[]required

Show child attributes

gradientnumber[][]default:[[]]required

last_updatedstring | nullrequired

likelihoodnumber[][]default:[[]]required

owner_namestringrequired

priorsnumber[]default:[]required

symptom_groupsobject[]default:[]required

Show child attributes

symptomsobject[]default:[]required

Show child attributes

template_idstringrequired

Required string length: 24 - 24

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

Example: 5eb7cf5a86d9755df3a6c593

userinfoobject | nullrequired

Show child attributes