PUT api/workorderhist/{id}

Update a work order history item

Request Information

Authentication

This method requires user authentication

URI Parameters

NameDescriptionTypeAdditional information
id

(Required)

integer

Required

Body Parameters

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.

Request Formats

application/json, text/json

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

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

This method has no specific response - It returns an empty success response if it completes without error.

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.

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)
  • 112: InvalidOperation
    (The operation is not valid., Conflict)
  • 113: WriteOperationFailed
    (The requested operation failed., Conflict)
  • 109: MissingRequiredJsonParameter
    (Invalid request format. A required parameter in the request body was not specified for this request., BadRequest)
  • 114: InvalidJsonParameterValue
    (Invalid request format. The value provided for one of the parameters in the request body was not in the correct format., BadRequest)