Downtime Tracking Resource

Is Work Order Attached To Offline Asset

HTTP Request

GET /api/downtime/{workOrderId}/workOrders

📋 Description: Retrieves a list of work orders associated with the specified downtime work order ID, enabling users to assess and manage related tasks efficiently.

Parameters

Name

In

Type

Required

Description

workOrderId

path

integer(int64)

true

Unique identifier for the work order

Responses

Status

Meaning

Description

Schema

200

OK

OK

string

Example Responses

1"string"

Find All Downtime History By Asset ID

HTTP Request

GET /api/downtime/{id}

📋 Description: Retrieves detailed information about a specific downtime event identified by the provided ID, enabling users to assess operational impacts and manage resources effectively.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

 1[
 2  {
 3    "id": 0,
 4    "createdBy": "string",
 5    "createdAt": "2019-08-24T14:15:22Z",
 6    "description": "string",
 7    "status": "ONLINE",
 8    "statusWithName": "string",
 9    "reason": "REPAIR",
10    "reasonWithName": "string",
11    "eventStartTime": "2019-08-24T14:15:22Z",
12    "eventStartDate": "2019-08-24",
13    "eventEndTime": "2019-08-24T14:15:22Z",
14    "eventEndDate": "2019-08-24",
15    "downtimeDurationInHours": 0,
16    "assetId": 0,
17    "workOrderId": 0,
18    "isNotified": true
19  }
20]

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[DowntimeTrackingDTO]

false

none

[Data transfer object representing the tracking and management of downtime events within operational processes, providing essential insights for performance optimization and resource allocation.]

» id

integer(int64)

false

none

Unique identifier for the resource

» createdBy

string

false

none

Username of who created this resource

» createdAt

string(date-time)

false

none

Timestamp when this resource was created

» description

string

false

none

Description of the resource

» status

string

false

none

Status of the resource

» statusWithName

string

false

none

Name of the status with

» reason

string

false

none

Description of the reason for downtime, providing context for operational disruptions within the tracking system.

» reasonWithName

string

false

none

Name of the reason with

» eventStartTime

string(date-time)

false

none

Time of the event start

» eventStartDate

string(date)

false

none

Date of the event start

» eventEndTime

string(date-time)

false

none

Time of the event end

» eventEndDate

string(date)

false

none

Date of the event end

» downtimeDurationInHours

integer(int64)

false

none

Represents the total duration of downtime, measured in hours, for tracking operational interruptions within the system.

» assetId

integer(int64)

false

none

Unique identifier for the asset

» workOrderId

integer(int64)

false

none

Unique identifier for the work order

» isNotified

boolean

false

none

Whether the resource is notified

Enumerated Values

Attribute

Value

reason

ARCHIVED, BREAKDOWN, FAILURE, MAINTENANCE, REPAIR, TRIGGERED

status

DOWNTIME, OFFLINE, ONLINE

Get All Downtime Statuses

HTTP Request

GET /api/downtime/statuses

📋 Description: Fetches the current statuses of system downtimes, providing essential insights for operational monitoring and decision-making.

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

1[
2  "string"
3]

Response Schema

Get All Downtime Reasons

HTTP Request

GET /api/downtime/reasons

📋 Description: Retrieves a list of downtime reasons, providing insights into potential service interruptions to enhance operational planning and decision-making.

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

1[
2  "string"
3]

Response Schema