GET v1/Clients/{clientId}/WorkOrders/{workOrderId}/Comments

Gets work order comments.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientId

Client identifier.

globally unique identifier

Required

workOrderId

Work Order identifier.

integer

Required

Body Parameters

None.

Response Information

Resource Description

A list.

Collection of WorkOrderCommentV1
NameDescriptionTypeAdditional information
WorkOrderId

The Work Order ID.

integer

None.

CommentId

The Comment ID.

integer

None.

InvoiceId

The Invoice Id (for invoice comments).

integer

None.

CommentType

The Work Order Comment Type.

WorkOrderCommentType

None.

Comment

The Work Order Comment.

string

None.

CreatedDateTimeUTC

The Created Date/Time UTC.

date

None.

CreatedId

The Created By Id (created by system if null value).

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "WorkOrderId": 1,
    "CommentId": 1,
    "InvoiceId": 1,
    "CommentType": 1,
    "Comment": "sample string 2",
    "CreatedDateTimeUTC": "2025-05-13T08:02:17.6293409+00:00",
    "CreatedId": 1
  },
  {
    "WorkOrderId": 1,
    "CommentId": 1,
    "InvoiceId": 1,
    "CommentType": 1,
    "Comment": "sample string 2",
    "CreatedDateTimeUTC": "2025-05-13T08:02:17.6293409+00:00",
    "CreatedId": 1
  }
]

application/xml, text/xml

Sample:
<ArrayOfWorkOrderComment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Titan.API.Core.Models.Maintenance">
  <WorkOrderComment>
    <Comment>sample string 2</Comment>
    <CommentId>1</CommentId>
    <CommentType>WorkOrderComments</CommentType>
    <CreatedDateTimeUTC>2025-05-13T08:02:17.6293409+00:00</CreatedDateTimeUTC>
    <CreatedId>1</CreatedId>
    <InvoiceId>1</InvoiceId>
    <WorkOrderId>1</WorkOrderId>
  </WorkOrderComment>
  <WorkOrderComment>
    <Comment>sample string 2</Comment>
    <CommentId>1</CommentId>
    <CommentType>WorkOrderComments</CommentType>
    <CreatedDateTimeUTC>2025-05-13T08:02:17.6293409+00:00</CreatedDateTimeUTC>
    <CreatedId>1</CreatedId>
    <InvoiceId>1</InvoiceId>
    <WorkOrderId>1</WorkOrderId>
  </WorkOrderComment>
</ArrayOfWorkOrderComment>