GET api/workorderhist/{id}

Get a workorder history item by Work Order History Item Id

Request Information

Authentication

This method requires user authentication

URI Parameters

NameDescriptionTypeAdditional information
id

(Required)Work Order History Item Id

integer

Required

Body Parameters

None.

Response Information

Resource Description

WorkordersHistoryItemsList
NameDescriptionTypeAdditional information
WorkOrderHistoryItemId

Work Order History Item Id.

integer

None.

WorkorderId

Work Order Id. See the GET api/workorders/{id} route to get the work order data.

integer

None.

WorkOrderHistoryItemTypeId

Work Order History Item Type Id. See GET api/workorderhistoryitemtypes to get history item types.

integer

None.

WorkOrderHistoryItemDate

Work Order History Item Date.

date

None.

WorkOrderHistoryItemDescription

Work Order History Item Description.

string

None.

WorkOrderHistoryItemComments

Work Order History Item Comments.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "WorkOrderHistoryItemId": 1,
  "WorkorderId": 2,
  "WorkOrderHistoryItemTypeId": 3,
  "WorkOrderHistoryItemDate": "2025-12-24T05:23:06.8653044-05:00",
  "WorkOrderHistoryItemDescription": "sample string 4",
  "WorkOrderHistoryItemComments": "sample string 5"
}

Internal Error Codes

  • 106: ResourceNotFound
    (The requested resource was not found., NotFound)
  • 100: MissingRequiredHeader
    (Invalid request format. A required HTTP header was not specified., BadRequest)
  • 118: InvalidHeaderValue
    (The value provided for one of the HTTP headers was not in the correct format., BadRequest)
  • 199: UnknownError
    (Internal server error., InternalServerError)
  • 105: ResourceNotLinkedToUser
    (User is trying to access a resource that belongs to a property not linked to the user., Forbidden)