POST v1/Clients/{clientId}/WorkOrder/Comments
Creates a Work Order Comment based on the provided information.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
clientId |
Client identifier. |
globally unique identifier |
Required |
Body Parameters
The work order comment.
WorkOrderCommentV1Name | Description | Type | Additional 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. |
Request Formats
application/json, text/json
Sample:
{ "WorkOrderId": 1, "CommentId": 1, "InvoiceId": 1, "CommentType": 1, "Comment": "sample string 2", "CreatedDateTimeUTC": "2025-07-01T11:17:46.7915732+00:00", "CreatedId": 1 }
application/xml, text/xml
Sample:
<WorkOrderComment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Titan.API.Core.Models.Maintenance"> <Comment>sample string 2</Comment> <CommentId>1</CommentId> <CommentType>WorkOrderComments</CommentType> <CreatedDateTimeUTC>2025-07-01T11:17:46.7915732+00:00</CreatedDateTimeUTC> <CreatedId>1</CreatedId> <InvoiceId>1</InvoiceId> <WorkOrderId>1</WorkOrderId> </WorkOrderComment>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Work Order Comment Id.
integerResponse Formats
application/json, text/json
Sample:
1
application/xml, text/xml
Sample:
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</int>