POST Comments/AddWorkflowComment
Adds a comment for the specified request and workflow activity.
Request Information
URI Parameters
None.
Body Parameters
The details of the new comment.
AddWFCommentDTOName | Description | Type | Additional information |
---|---|---|---|
RequestID |
The ID of the request. |
globally unique identifier |
None. |
WorkflowActivityID |
The ID of the workflow stop the comment is for. |
globally unique identifier |
None. |
Comment |
The comment. |
string |
None. |
Request Formats
application/json, text/json
Sample:
{ "results": [ { "RequestID": "cba8f1d0-490b-4bca-898c-82ffd45f9cfe", "WorkflowActivityID": "35bd6109-406d-457f-b414-b2221dcd47fc", "Comment": "sample string 2" } ] }
text/javascript
Sample:
{"results":[{"RequestID":"cba8f1d0-490b-4bca-898c-82ffd45f9cfe","WorkflowActivityID":"35bd6109-406d-457f-b414-b2221dcd47fc","Comment":"sample string 2"}]}
application/bson
Sample:
Binary JSON content. See http://bsonspec.org for details.
application/xml, text/xml
Sample:
<AddWFCommentDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Lpp.Dns.DTO"> <Comment>sample string 2</Comment> <RequestID>cba8f1d0-490b-4bca-898c-82ffd45f9cfe</RequestID> <WorkflowActivityID>35bd6109-406d-457f-b414-b2221dcd47fc</WorkflowActivityID> </AddWFCommentDTO>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
A WFCommentDTO containing the details of the new comment.
WFCommentDTOName | Description | Type | Additional information |
---|---|---|---|
Comment |
The comment content. |
string |
None. |
CreatedOn |
The date the comment was created on. |
date |
None. |
CreatedByID |
The ID of the user that created the comment. |
globally unique identifier |
None. |
CreatedBy |
The username of the person that created the comment. |
string |
None. |
RequestID |
The ID of the request the comment is associated with. |
globally unique identifier |
None. |
TaskID |
The ID of the task associated to the comment. |
globally unique identifier |
None. |
WorkflowActivityID |
The workflow activity ID the task is associated with. |
globally unique identifier |
None. |
WorkflowActivity |
The name of the workflow activity. |
string |
None. |
ID | globally unique identifier |
None. |
|
Timestamp | Collection of byte |
None. |
Response Formats
application/json, text/json
Sample:
{ "results": [ { "Comment": "sample string 1", "CreatedOn": "2024-05-14T10:06:11Z", "CreatedByID": "22732b18-c037-49b4-9e33-c82f441c2753", "CreatedBy": "sample string 4", "RequestID": "71a4c77e-b966-4f89-b14b-5ec35c06ec73", "TaskID": "4d279189-6b3a-4ece-b8d3-2cc7967db5c9", "WorkflowActivityID": "48f079f8-821b-4c40-81e9-3fa393556e68", "WorkflowActivity": "sample string 6", "ID": "e52862dc-a873-4430-be6b-0ad0a41b39cb", "Timestamp": "QEA=" } ] }
text/javascript
Sample:
{"results":[{"Comment":"sample string 1","CreatedOn":"2024-05-14T10:06:11Z","CreatedByID":"22732b18-c037-49b4-9e33-c82f441c2753","CreatedBy":"sample string 4","RequestID":"71a4c77e-b966-4f89-b14b-5ec35c06ec73","TaskID":"4d279189-6b3a-4ece-b8d3-2cc7967db5c9","WorkflowActivityID":"48f079f8-821b-4c40-81e9-3fa393556e68","WorkflowActivity":"sample string 6","ID":"e52862dc-a873-4430-be6b-0ad0a41b39cb","Timestamp":"QEA="}]}
application/bson
Sample:
Binary JSON content. See http://bsonspec.org for details.
application/xml, text/xml
Sample:
<WFCommentDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Lpp.Dns.DTO"> <ID xmlns="http://schemas.datacontract.org/2004/07/Lpp.Objects">e52862dc-a873-4430-be6b-0ad0a41b39cb</ID> <Timestamp xmlns="http://schemas.datacontract.org/2004/07/Lpp.Objects">QEA=</Timestamp> <Comment>sample string 1</Comment> <CreatedBy>sample string 4</CreatedBy> <CreatedByID>22732b18-c037-49b4-9e33-c82f441c2753</CreatedByID> <CreatedOn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System"> <d2p1:DateTime>2024-05-14T14:06:11.5331952Z</d2p1:DateTime> <d2p1:OffsetMinutes>-240</d2p1:OffsetMinutes> </CreatedOn> <RequestID>71a4c77e-b966-4f89-b14b-5ec35c06ec73</RequestID> <TaskID>4d279189-6b3a-4ece-b8d3-2cc7967db5c9</TaskID> <WorkflowActivity>sample string 6</WorkflowActivity> <WorkflowActivityID>48f079f8-821b-4c40-81e9-3fa393556e68</WorkflowActivityID> </WFCommentDTO>