Skip to main content
The schema below is rendered directly from the published OpenAPI 3.1 contract.

Employee incident details.

​
id
string
required
read-only

Unique incident identifier.

Minimum string length: 1
Pattern: ^[0-9a-fA-F]{24}$
Example:

"730000000000000000000001"

​
employeeIncidentNumber
integer
required
read-only

Tenant-facing numeric incident number assigned by the server.

Must be a multiple of 1
Example:

37

​
type
enum<string>
required

Incident type. Values are case-sensitive.

Available options:
temporary,
permanent
Minimum string length: 1
Example:

"temporary"

​
status
enum<string>
required
read-only

Server-managed incident lifecycle status.

Available options:
reported,
in_progress,
completed,
archived
Minimum string length: 1
Example:

"reported"

​
employee
string
required

Identifier of the affected employee.

Pattern: ^[0-9a-fA-F]{24}$
Example:

"68a000000000000000000001"

​
reportedBy
enum<string>
required
read-only

Actor category that originally reported the incident.

Available options:
user,
api_key
Minimum string length: 1
Example:

"api_key"

​
reportedAt
string<date-time>
required
read-only

UTC timestamp at which the incident was reported.

Minimum string length: 1
Pattern: Z$
Example:

"2026-07-21T07:30:00.000Z"

​
dateFrom
string<date-time>
required

UTC timestamp from which the incident applies.

Minimum string length: 1
Pattern: Z$
Example:

"2026-07-21T00:00:00.000Z"

​
dateUntil
string<date-time> | null
required
nullable

UTC timestamp until which the incident applies, or null while no end is set.

Minimum string length: 1
Pattern: Z$
Example:

null

​
createdAt
string<date-time>
required
read-only

UTC timestamp at which the incident record was created.

Minimum string length: 1
Pattern: Z$
Example:

"2026-07-21T07:30:00.000Z"

​
updatedAt
string<date-time>
required
read-only

UTC timestamp of the latest incident update.

Minimum string length: 1
Pattern: Z$
Example:

"2026-07-21T07:30:00.000Z"

Last modified on August 26, 2026