GET Comments/ByRequestID?requestID={requestID}&workflowActivityID={workflowActivityID}
Gets all comments associated to the specified Request.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
requestID |
The ID of the request. |
globally unique identifier |
Required |
workflowActivityID |
The optional ID of the specific workflow activity to get the comments for. |
globally unique identifier |
None. |
Body Parameters
None.
Response Information
Resource Description
WFCommentDTOs
Collection of 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-14T13:32:10Z", "CreatedByID": "e3a73c13-b3ee-41b2-9d10-a38ed138cf9c", "CreatedBy": "sample string 4", "RequestID": "5c3021ff-e700-48c3-9810-3c5f8577e0cc", "TaskID": "e7d25b5c-7b22-4d09-8395-de5e5436c14a", "WorkflowActivityID": "86d19c34-3e57-4f3a-8d32-73252695f9f1", "WorkflowActivity": "sample string 6", "ID": "517d40c3-4947-4452-a830-f7c93ca2dd29", "Timestamp": "QEA=" }, { "Comment": "sample string 1", "CreatedOn": "2024-05-14T13:32:10Z", "CreatedByID": "e3a73c13-b3ee-41b2-9d10-a38ed138cf9c", "CreatedBy": "sample string 4", "RequestID": "5c3021ff-e700-48c3-9810-3c5f8577e0cc", "TaskID": "e7d25b5c-7b22-4d09-8395-de5e5436c14a", "WorkflowActivityID": "86d19c34-3e57-4f3a-8d32-73252695f9f1", "WorkflowActivity": "sample string 6", "ID": "517d40c3-4947-4452-a830-f7c93ca2dd29", "Timestamp": "QEA=" } ] }
text/javascript
Sample:
{"results":[{"Comment":"sample string 1","CreatedOn":"2024-05-14T13:32:10Z","CreatedByID":"e3a73c13-b3ee-41b2-9d10-a38ed138cf9c","CreatedBy":"sample string 4","RequestID":"5c3021ff-e700-48c3-9810-3c5f8577e0cc","TaskID":"e7d25b5c-7b22-4d09-8395-de5e5436c14a","WorkflowActivityID":"86d19c34-3e57-4f3a-8d32-73252695f9f1","WorkflowActivity":"sample string 6","ID":"517d40c3-4947-4452-a830-f7c93ca2dd29","Timestamp":"QEA="},{"Comment":"sample string 1","CreatedOn":"2024-05-14T13:32:10Z","CreatedByID":"e3a73c13-b3ee-41b2-9d10-a38ed138cf9c","CreatedBy":"sample string 4","RequestID":"5c3021ff-e700-48c3-9810-3c5f8577e0cc","TaskID":"e7d25b5c-7b22-4d09-8395-de5e5436c14a","WorkflowActivityID":"86d19c34-3e57-4f3a-8d32-73252695f9f1","WorkflowActivity":"sample string 6","ID":"517d40c3-4947-4452-a830-f7c93ca2dd29","Timestamp":"QEA="}]}
application/bson
Sample:
Binary JSON content. See http://bsonspec.org for details.
application/xml, text/xml
Sample:
<ArrayOfWFCommentDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Lpp.Dns.DTO"> <WFCommentDTO> <ID xmlns="http://schemas.datacontract.org/2004/07/Lpp.Objects">517d40c3-4947-4452-a830-f7c93ca2dd29</ID> <Timestamp xmlns="http://schemas.datacontract.org/2004/07/Lpp.Objects">QEA=</Timestamp> <Comment>sample string 1</Comment> <CreatedBy>sample string 4</CreatedBy> <CreatedByID>e3a73c13-b3ee-41b2-9d10-a38ed138cf9c</CreatedByID> <CreatedOn xmlns:d3p1="http://schemas.datacontract.org/2004/07/System"> <d3p1:DateTime>2024-05-14T17:32:10.8702025Z</d3p1:DateTime> <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes> </CreatedOn> <RequestID>5c3021ff-e700-48c3-9810-3c5f8577e0cc</RequestID> <TaskID>e7d25b5c-7b22-4d09-8395-de5e5436c14a</TaskID> <WorkflowActivity>sample string 6</WorkflowActivity> <WorkflowActivityID>86d19c34-3e57-4f3a-8d32-73252695f9f1</WorkflowActivityID> </WFCommentDTO> <WFCommentDTO> <ID xmlns="http://schemas.datacontract.org/2004/07/Lpp.Objects">517d40c3-4947-4452-a830-f7c93ca2dd29</ID> <Timestamp xmlns="http://schemas.datacontract.org/2004/07/Lpp.Objects">QEA=</Timestamp> <Comment>sample string 1</Comment> <CreatedBy>sample string 4</CreatedBy> <CreatedByID>e3a73c13-b3ee-41b2-9d10-a38ed138cf9c</CreatedByID> <CreatedOn xmlns:d3p1="http://schemas.datacontract.org/2004/07/System"> <d3p1:DateTime>2024-05-14T17:32:10.8702025Z</d3p1:DateTime> <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes> </CreatedOn> <RequestID>5c3021ff-e700-48c3-9810-3c5f8577e0cc</RequestID> <TaskID>e7d25b5c-7b22-4d09-8395-de5e5436c14a</TaskID> <WorkflowActivity>sample string 6</WorkflowActivity> <WorkflowActivityID>86d19c34-3e57-4f3a-8d32-73252695f9f1</WorkflowActivityID> </WFCommentDTO> </ArrayOfWFCommentDTO>