Get incidents.
get
/connectedWorker/clientapi/v2/orgs/{orgId}/incidents
This operation retrieves incidents.
Request
Path Parameters
-
orgId: string
Organization identifier
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Incidents were successfully retrieved
Root Schema : Incidents
Type:
Show Source
object
-
items:
array items
-
links(optional):
array links
Read Only:
true
Nested Schema : Incident
Type:
Show Source
object
-
altitude(optional):
number
Altitude of occurrence of the incident. Used only for incident creation.Example:
12.12345
-
createdTime(optional):
string(date-time)
Read Only:
true
Time when the incident was created in ISO-8601 format. -
description:
string
Description of the incident. Can be updated. Cannot be blank.Example:
Description of an incident
-
employeeId(optional):
string
Id of the employee for whom the incident was created.Example:
johnSmith
-
externalId(optional):
string
Read Only:
true
Id in external service if integration is enabled.Example:123
-
externalService(optional):
string
Read Only:
true
Identifier of external service where incident is integrated.Example:HCM_HNS
-
id(optional):
string
Read Only:
true
The unique id of the objectExample:53
-
lastModifiedTime(optional):
string(date-time)
Read Only:
true
Time when the incident was modified for the last time in ISO-8601 format. -
latitude(optional):
number
Minimum Value:
-90
Maximum Value:90
Latitude of occurrence of the incident. Used only for incident creation.Example:39.215302
-
links(optional):
array links
-
locationId(optional):
string
Id of the location for which the incident was created.Example:
123
-
longitude(optional):
number
Minimum Value:
-180
Maximum Value:180
Longitude of occurrence of the incident. Used only for incident creationExample:26.308674
-
organizationId(optional):
string
Id of the organizationExample:
52
-
priority:
string
Allowed Values:
[ "HIGH", "MEDIUM", "LOW" ]
Priority of the incident.Example:HIGH
-
source(optional):
string
Read Only:
true
Allowed Values:[ "RULE", "MANUALLY_CREATED" ]
Source of the incident.Example:RULE
-
sourceType:
string
Read Only:
true
Allowed Values:[ "EMPLOYEE", "LOCATION" ]
Rule source type for the incident.Example:EMPLOYEE
-
state(optional):
string
Allowed Values:
[ "NEW", "OPEN", "WORK_IN_PROGRESS", "RESOLVED", "WITHDRAWN", "SEND_TO_EXTERNAL_PROCESSING" ]
State of the incident. Automatically assigned to 'NEW' on backend during creation of the incident. Can be updated.Example:NEW
-
summary:
string
Minimum Length:
0
Maximum Length:255
Summary of the incident. Can be updated. Cannot be blank. Max length is 255 characters.Example:This is a summary of an incident
-
tags(optional):
array tags
Unique Items Required:
true
Tags for this incident. Can be updated. -
type:
string
Allowed Values:
[ "HAZARD", "SAFETY_VIOLATION", "ACCIDENT" ]
Type of the incident.Example:HAZARD
Nested Schema : Link
Type:
Show Source
object
-
href:
string
The target resource's URI
-
rel:
string
Relation type