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-15T02:52:44Z", "CreatedByID": "724042cc-7b96-4464-861c-09e90f9bfd3f", "CreatedBy": "sample string 4", "RequestID": "3e6486c9-6869-4e1a-83f2-312e091a087a", "TaskID": "06d67ac3-53a6-44c9-912f-24c09b610d21", "WorkflowActivityID": "c08b0e65-0730-4ee2-9fc6-1f0eee3bca74", "WorkflowActivity": "sample string 6", "ID": "2763ce6f-8379-4b0a-adae-bd0d42b8b350", "Timestamp": "QEA=" }, { "Comment": "sample string 1", "CreatedOn": "2024-05-15T02:52:44Z", "CreatedByID": "724042cc-7b96-4464-861c-09e90f9bfd3f", "CreatedBy": "sample string 4", "RequestID": "3e6486c9-6869-4e1a-83f2-312e091a087a", "TaskID": "06d67ac3-53a6-44c9-912f-24c09b610d21", "WorkflowActivityID": "c08b0e65-0730-4ee2-9fc6-1f0eee3bca74", "WorkflowActivity": "sample string 6", "ID": "2763ce6f-8379-4b0a-adae-bd0d42b8b350", "Timestamp": "QEA=" } ] }
text/javascript
Sample:
{"results":[{"Comment":"sample string 1","CreatedOn":"2024-05-15T02:52:44Z","CreatedByID":"724042cc-7b96-4464-861c-09e90f9bfd3f","CreatedBy":"sample string 4","RequestID":"3e6486c9-6869-4e1a-83f2-312e091a087a","TaskID":"06d67ac3-53a6-44c9-912f-24c09b610d21","WorkflowActivityID":"c08b0e65-0730-4ee2-9fc6-1f0eee3bca74","WorkflowActivity":"sample string 6","ID":"2763ce6f-8379-4b0a-adae-bd0d42b8b350","Timestamp":"QEA="},{"Comment":"sample string 1","CreatedOn":"2024-05-15T02:52:44Z","CreatedByID":"724042cc-7b96-4464-861c-09e90f9bfd3f","CreatedBy":"sample string 4","RequestID":"3e6486c9-6869-4e1a-83f2-312e091a087a","TaskID":"06d67ac3-53a6-44c9-912f-24c09b610d21","WorkflowActivityID":"c08b0e65-0730-4ee2-9fc6-1f0eee3bca74","WorkflowActivity":"sample string 6","ID":"2763ce6f-8379-4b0a-adae-bd0d42b8b350","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">2763ce6f-8379-4b0a-adae-bd0d42b8b350</ID> <Timestamp xmlns="http://schemas.datacontract.org/2004/07/Lpp.Objects">QEA=</Timestamp> <Comment>sample string 1</Comment> <CreatedBy>sample string 4</CreatedBy> <CreatedByID>724042cc-7b96-4464-861c-09e90f9bfd3f</CreatedByID> <CreatedOn xmlns:d3p1="http://schemas.datacontract.org/2004/07/System"> <d3p1:DateTime>2024-05-15T06:52:44.0033936Z</d3p1:DateTime> <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes> </CreatedOn> <RequestID>3e6486c9-6869-4e1a-83f2-312e091a087a</RequestID> <TaskID>06d67ac3-53a6-44c9-912f-24c09b610d21</TaskID> <WorkflowActivity>sample string 6</WorkflowActivity> <WorkflowActivityID>c08b0e65-0730-4ee2-9fc6-1f0eee3bca74</WorkflowActivityID> </WFCommentDTO> <WFCommentDTO> <ID xmlns="http://schemas.datacontract.org/2004/07/Lpp.Objects">2763ce6f-8379-4b0a-adae-bd0d42b8b350</ID> <Timestamp xmlns="http://schemas.datacontract.org/2004/07/Lpp.Objects">QEA=</Timestamp> <Comment>sample string 1</Comment> <CreatedBy>sample string 4</CreatedBy> <CreatedByID>724042cc-7b96-4464-861c-09e90f9bfd3f</CreatedByID> <CreatedOn xmlns:d3p1="http://schemas.datacontract.org/2004/07/System"> <d3p1:DateTime>2024-05-15T06:52:44.0033936Z</d3p1:DateTime> <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes> </CreatedOn> <RequestID>3e6486c9-6869-4e1a-83f2-312e091a087a</RequestID> <TaskID>06d67ac3-53a6-44c9-912f-24c09b610d21</TaskID> <WorkflowActivity>sample string 6</WorkflowActivity> <WorkflowActivityID>c08b0e65-0730-4ee2-9fc6-1f0eee3bca74</WorkflowActivityID> </WFCommentDTO> </ArrayOfWFCommentDTO>