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": "a4ff7c5e-81dd-4a7b-ab78-42115834fdf1", "WorkflowActivityID": "490a9025-6fc8-4bf0-8a71-95c3b31a0966", "Comment": "sample string 2" } ] }
text/javascript
Sample:
{"results":[{"RequestID":"a4ff7c5e-81dd-4a7b-ab78-42115834fdf1","WorkflowActivityID":"490a9025-6fc8-4bf0-8a71-95c3b31a0966","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>a4ff7c5e-81dd-4a7b-ab78-42115834fdf1</RequestID> <WorkflowActivityID>490a9025-6fc8-4bf0-8a71-95c3b31a0966</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-15T08:13:33Z", "CreatedByID": "97ccc41c-7250-4f39-b45c-700a859010d5", "CreatedBy": "sample string 4", "RequestID": "bb464c4c-d59c-4b9e-a122-976fd325f1de", "TaskID": "77b8aef4-00a5-4c20-b757-089b83d01275", "WorkflowActivityID": "5352d472-cd57-423c-8e9d-f3f97d5c8ce7", "WorkflowActivity": "sample string 6", "ID": "27296673-77cb-4f09-b95f-761013d0a4c6", "Timestamp": "QEA=" } ] }
text/javascript
Sample:
{"results":[{"Comment":"sample string 1","CreatedOn":"2024-05-15T08:13:33Z","CreatedByID":"97ccc41c-7250-4f39-b45c-700a859010d5","CreatedBy":"sample string 4","RequestID":"bb464c4c-d59c-4b9e-a122-976fd325f1de","TaskID":"77b8aef4-00a5-4c20-b757-089b83d01275","WorkflowActivityID":"5352d472-cd57-423c-8e9d-f3f97d5c8ce7","WorkflowActivity":"sample string 6","ID":"27296673-77cb-4f09-b95f-761013d0a4c6","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">27296673-77cb-4f09-b95f-761013d0a4c6</ID> <Timestamp xmlns="http://schemas.datacontract.org/2004/07/Lpp.Objects">QEA=</Timestamp> <Comment>sample string 1</Comment> <CreatedBy>sample string 4</CreatedBy> <CreatedByID>97ccc41c-7250-4f39-b45c-700a859010d5</CreatedByID> <CreatedOn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System"> <d2p1:DateTime>2024-05-15T12:13:33.1170644Z</d2p1:DateTime> <d2p1:OffsetMinutes>-240</d2p1:OffsetMinutes> </CreatedOn> <RequestID>bb464c4c-d59c-4b9e-a122-976fd325f1de</RequestID> <TaskID>77b8aef4-00a5-4c20-b757-089b83d01275</TaskID> <WorkflowActivity>sample string 6</WorkflowActivity> <WorkflowActivityID>5352d472-cd57-423c-8e9d-f3f97d5c8ce7</WorkflowActivityID> </WFCommentDTO>