Create a Risk for a Participant

post/public/v1/participants/{participant}/risks

post/public/v1/participants/{participant}/risks

curl --request POST \
  --url 'https://api.app.astalty.com.au/public/v1/participants/{participant}/risks' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "string",
  "description": "string",
  "likelihood": 5,
  "consequence": 1,
  "residual_likelihood": 5,
  "risk_to": "business",
  "status": "active",
  "review_frequency": "annually",
  "visible_to_support_workers": true,
  "risk_management_type": "active",
  "controls": [
    {
      "title": "string",
      "description": "string"
    }
  ]
}'

Response

{
  "data": {
    "id": "r1i2s3k4-d5e6-47f8-9a0b-1c2d3e4f5a6b",
    "title": "Falls risk during transfers",
    "description": "Participant has a history of falls",
    "likelihood": "possible",
    "consequence": "moderate",
    "residual_likelihood": "unlikely",
    "inherent_risk": {
      "score": 12,
      "level": "high"
    },
    "residual_risk": {
      "score": 12,
      "level": "high"
    },
    "risk_to": "participant",
    "status": "active",
    "risk_management_type": "treat",
    "review_frequency": "quarterly",
    "visible_to_support_workers": false,
    "last_reviewed_at": "2024-01-15T10:30:00+00:00",
    "next_review_at": "2024-04-15T10:30:00+00:00",
    "archived_at": "2024-01-15T10:30:00+00:00",
    "created_at": "2024-01-15T10:30:00+00:00",
    "controls": [
      {
        "id": "c1o2n3t4-r5o6-47l8-9a0b-1c2d3e4f5a6b",
        "title": "Use transfer belt",
        "description": "Always use a transfer belt when assisting",
        "created_at": "2024-01-15T10:30:00+00:00"
      }
    ]
  }
}

Authorization

Authorizationstringrequired
Bearer authentication header of the form Bearer <token>, where <token> is your API key. See How to set up an API key.

Path parameters

participantstringrequired
The participant UUID

Body

application/json

titlestringrequiredmax length 255
descriptionstringrequiredmax length 6000
likelihoodenum<integer>required
Available options:54312
consequenceenum<integer>required
Available options:14235
residual_likelihoodenum<integer>required
Available options:54312
risk_toenum<string>required
Available options:businessothersparticipantstaff
statusenum<string>required
Available options:active
review_frequencyenum<string>required
Available options:annuallymonthlyquarterlysix-monthlyweekly
visible_to_support_workersboolean
risk_management_typeenum<string>
Available options:activestatic
controlsobject[]max items 100
▶Show 2 child attributesHide child attributes
- titlestringrequiredmax length 255
- descriptionstring | nullmax length 65535
  Limited to 65535 bytes.

Response

200application/json

ParticipantRiskResource

dataobjectrequired
▶Show 18 child attributesHide child attributes
- idstringrequired
  Example:r1i2s3k4-d5e6-47f8-9a0b-1c2d3e4f5a6b
- titlestringrequired
  Example:Falls risk during transfers
- descriptionstring | nullrequired
  Example:Participant has a history of falls
- likelihoodintegerrequired
  Example:possible
- consequenceintegerrequired
  Example:moderate
- residual_likelihoodintegerrequired
  Example:unlikely
- inherent_riskobjectrequired
  ▶Show 2 child attributesHide child attributes
  scoreintegerrequired
  Example:12
  levelenum<string>required
  Available options:catastrophichighlowmoderate
- residual_riskobjectrequired
  ▶Show 2 child attributesHide child attributes
  scoreintegerrequired
  Example:12
  levelenum<string>required
  Available options:catastrophichighlowmoderate
- risk_tostringrequired
  Example:participant
- statusstringrequired
  Example:active
- risk_management_typestringrequired
  Example:treat
- review_frequencystringrequired
  Example:quarterly
- visible_to_support_workersbooleanrequired
  Example:false
- last_reviewed_atstring | nullrequired
  Example:2024-01-15T10:30:00+00:00
- next_review_atstringrequired
  Example:2024-04-15T10:30:00+00:00
- archived_atstring | nullrequired
  Example:2024-01-15T10:30:00+00:00
- created_atstringrequired
  Example:2024-01-15T10:30:00+00:00
- controlsobject[]required
  ▶Show 4 child attributesHide child attributes
  idstringrequired
  Example:c1o2n3t4-r5o6-47l8-9a0b-1c2d3e4f5a6b
  titlestringrequired
  Example:Use transfer belt
  descriptionstring | nullrequired
  Example:Always use a transfer belt when assisting
  created_atstringrequired
  Example:2024-01-15T10:30:00+00:00

Errors

401Unauthenticated
403Authorization error
404Not found
422Validation error

Command Palette

Authorization

Path parameters

Body

Response

Errors