Athena Documentation
Workflow
API Documentation
- GETList all cases
- GETRetrieve a specific case
- DELDelete a specific case
- PATCHUpdate a specific case
- PATCHUpdate alert risk rating for a case
- PATCHApprove a case
- PATCHAssign a case to a checker
- PATCHAssign a case to a maker
- DELDelete document from a case
- DELDelete findings from a case
- PATCHAdd document to a case
- PATCHAdd findings to a case
- GETGenerate case report
- PATCHReopen a case
- PATCHAdd report code to a case
- PATCHAdd report indicator to a case
- GETList transactions for a specific case
- GETGet active cases
- GETGet active cases statistics
- GETGet cases by assignee
- GETGet cases by bucket
- POSTBulk approve multiple cases
- PATCHBulk assign cases
- POSTBulk upload documents to multiple cases
- POSTBulk add findings to multiple cases
- GETGet case status options
- GETGet closed cases
- GETExport cases to CSV
- GETGet inactive cases
- GETGet cases by priority
- GETGet cases by rule
- GETGet cases by status
- GETGet cases timeline
- GETGet violations statistics
Update alert risk rating for a case
curl --request PATCH \
--url http://localhost/api/api/cases/{id}/alert \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'{
"id": 123,
"case_status": "<string>",
"ageing": 123,
"priority": 123,
"case_status_order": 123,
"alert_date": "<string>",
"assignee": {
"id": 123,
"name": "<string>"
},
"bucket": {
"id": 123,
"name": "<string>"
},
"case_action": "<string>",
"case_subjects": {
"subject_1": {
"id": 123,
"name": "<string>",
"client_subject_id": "<string>"
},
"subject_2": {
"id": 123,
"name": "<string>",
"client_subject_id": "<string>"
}
},
"created_on": "<string>",
"rule": 123,
"active_timestamp": "2023-11-07T05:31:56Z"
}Case
Update alert risk rating for a case
Update the alert risk rating for a specific case.
PATCH
/
api
/
cases
/
{id}
/
alert
Update alert risk rating for a case
curl --request PATCH \
--url http://localhost/api/api/cases/{id}/alert \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'{
"id": 123,
"case_status": "<string>",
"ageing": 123,
"priority": 123,
"case_status_order": 123,
"alert_date": "<string>",
"assignee": {
"id": 123,
"name": "<string>"
},
"bucket": {
"id": 123,
"name": "<string>"
},
"case_action": "<string>",
"case_subjects": {
"subject_1": {
"id": 123,
"name": "<string>",
"client_subject_id": "<string>"
},
"subject_2": {
"id": 123,
"name": "<string>",
"client_subject_id": "<string>"
}
},
"created_on": "<string>",
"rule": 123,
"active_timestamp": "2023-11-07T05:31:56Z"
}Documentation Index
Fetch the complete documentation index at: https://docs.cynopsis.co/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
CustomAuthenticationcookieAuth
JWT token obtained from AWS Cognito or custom authentication service
Path Parameters
A unique integer value identifying this case.
Body
application/json
Available options:
HIGH, MEDIUM, LOW, Unrated Response
Alert risk rating updated successfully.
Case object with all details
Case ID
Current case status
Days since case creation
Case priority level
Internal case status order
Alert date timestamp
Risk rating
Available options:
HIGH, MEDIUM, LOW, Unrated Case assignee information
Show child attributes
Show child attributes
Bucket information
Show child attributes
Show child attributes
Last action taken on case
Case subjects information
Show child attributes
Show child attributes
Case creation date
Rule number ID that triggered the case
When case became active
⌘I