Jump to

• Request
• Response

Get an incident.

get

/connectedWorker/clientapi/v2/orgs/{orgId}/incidents/{incidentId}

This operation retrieves the details of a specific incident.

Request

Path Parameters

• incidentId: string
  Incident identifier
• orgId: string
  Organization identifier

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Incident was successfully retrieved.

Body ()

Root Schema : Incident

Type: object

Show Source

• 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 object

  Example: 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 creation

  Example: 26.308674
• organizationId(optional): string
  Id of the organization

  Example: 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

{
    "required":[
        "description",
        "priority",
        "sourceType",
        "summary",
        "type"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The unique id of the object",
            "readOnly":true,
            "example":"53"
        },
        "type":{
            "type":"string",
            "description":"Type of the incident.",
            "example":"HAZARD",
            "enum":[
                "HAZARD",
                "SAFETY_VIOLATION",
                "ACCIDENT"
            ]
        },
        "source":{
            "type":"string",
            "description":"Source of the incident.",
            "readOnly":true,
            "example":"RULE",
            "enum":[
                "RULE",
                "MANUALLY_CREATED"
            ]
        },
        "sourceType":{
            "type":"string",
            "description":"Rule source type for the incident.",
            "readOnly":true,
            "example":"EMPLOYEE",
            "enum":[
                "EMPLOYEE",
                "LOCATION"
            ]
        },
        "priority":{
            "type":"string",
            "description":"Priority of the incident.",
            "example":"HIGH",
            "enum":[
                "HIGH",
                "MEDIUM",
                "LOW"
            ]
        },
        "state":{
            "type":"string",
            "description":"State of the incident. Automatically assigned to 'NEW' on backend during creation of the incident. Can be updated.",
            "example":"NEW",
            "enum":[
                "NEW",
                "OPEN",
                "WORK_IN_PROGRESS",
                "RESOLVED",
                "WITHDRAWN",
                "SEND_TO_EXTERNAL_PROCESSING"
            ]
        },
        "description":{
            "type":"string",
            "description":"Description of the incident. Can be updated. Cannot be blank.",
            "example":"Description of an incident"
        },
        "summary":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Summary of the incident. Can be updated. Cannot be blank. Max length is 255 characters.",
            "example":"This is a summary of an incident"
        },
        "createdTime":{
            "type":"string",
            "description":"Time when the incident was created in ISO-8601 format.",
            "format":"date-time",
            "readOnly":true
        },
        "lastModifiedTime":{
            "type":"string",
            "description":"Time when the incident was modified for the last time in ISO-8601 format.",
            "format":"date-time",
            "readOnly":true
        },
        "tags":{
            "uniqueItems":true,
            "type":"array",
            "description":"Tags for this incident. Can be updated.",
            "example":[
                "tag1",
                "tag2"
            ],
            "items":{
                "type":"string",
                "description":"Tags for this incident. Can be updated.",
                "example":"[\"tag1\",\"tag2\"]"
            }
        },
        "employeeId":{
            "type":"string",
            "description":"Id of the employee for whom the incident was created. ",
            "example":"johnSmith"
        },
        "locationId":{
            "type":"string",
            "description":"Id of the location for which the incident was created. ",
            "example":"123"
        },
        "latitude":{
            "maximum":90,
            "minimum":-90,
            "type":"number",
            "description":"Latitude of occurrence of the incident. Used only for incident creation.",
            "writeOnly":true,
            "example":39.215302
        },
        "longitude":{
            "maximum":180,
            "minimum":-180,
            "type":"number",
            "description":"Longitude of occurrence of the incident. Used only for incident creation",
            "writeOnly":true,
            "example":26.308674
        },
        "altitude":{
            "type":"number",
            "description":"Altitude of occurrence of the incident. Used only for incident creation.",
            "writeOnly":true,
            "example":12.12345
        },
        "externalId":{
            "type":"string",
            "description":"Id in external service if integration is enabled.",
            "readOnly":true,
            "example":"123"
        },
        "externalService":{
            "type":"string",
            "description":"Identifier of external service where incident is integrated.",
            "readOnly":true,
            "example":"HCM_HNS"
        },
        "organizationId":{
            "type":"string",
            "description":"Id of the organization",
            "writeOnly":true,
            "example":"52"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : tags

Type: array

Unique Items Required: true

Tags for this incident. Can be updated.

Show Source

• Array of: string
  Tags for this incident. Can be updated.

  Example: ["tag1","tag2"]

{
    "uniqueItems":true,
    "type":"array",
    "description":"Tags for this incident. Can be updated.",
    "example":[
        "tag1",
        "tag2"
    ],
    "items":{
        "type":"string",
        "description":"Tags for this incident. Can be updated.",
        "example":"[\"tag1\",\"tag2\"]"
    }
}

Example:

[
    "tag1",
    "tag2"
]

Nested Schema : Link

Type: object

Show Source

• href: string
  The target resource's URI
• rel: string
  Relation type

{
    "required":[
        "href",
        "rel"
    ],
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Relation type"
        },
        "href":{
            "type":"string",
            "description":"The target resource's URI"
        }
    }
}

Back to Top