Get an employee alert.
get
/connectedWorker/clientapi/v2/employees/{employeeId}/alerts/{alertId}
This operation retrieves an employee alert.
Request
Path Parameters
-
alertId: string
Employee alert identifier
-
employeeId: string
Employee identifier
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Employee alert was successfully retrieved.
Root Schema : EmployeeAlert
Type:
Show Source
object
-
createdTime(optional):
string(date-time)
Read Only:
true
Time when an alert was created -
employeeId:
string
Id of the employee affected by an alertExample:
51
-
id(optional):
string
Read Only:
true
The unique id of the objectExample:53
-
links(optional):
array links
-
message:
string
Descriptive text of an alertExample:
Fall detected
-
priority:
string
Allowed Values:
[ "LOW", "MEDIUM", "HIGH" ]
Priority of the employee alertExample:LOW
-
resolvedTime(optional):
string(date-time)
Read Only:
true
Time when an alert was resolved -
status(optional):
string
Read Only:
true
Allowed Values:[ "ACTIVE", "RESOLVED" ]
Status of the employee alert. Automatically assigned to 'ACTIVE' on backend during creation of the alert. Can be updated.Example:ACTIVE
Nested Schema : Link
Type:
Show Source
object
-
href:
string
The target resource's URI
-
rel:
string
Relation type