GET Comments/ByDocumentID?documentID={documentID}
Gets WFComments based on the document ID specified.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
documentID |
The ID of the document. |
globally unique identifier |
Required |
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-15T23:12:46Z", "CreatedByID": "63217593-3c90-4528-a6f1-8307c8f7824a", "CreatedBy": "sample string 4", "RequestID": "de69f19d-0ccf-43c4-ade1-9ca971b5c96a", "TaskID": "60afd2ca-1bf6-4fe0-89b1-dfe12880ce2e", "WorkflowActivityID": "9cc77120-20db-463a-9a36-ccb6cf5b3bf4", "WorkflowActivity": "sample string 6", "ID": "5716d5aa-820f-4711-a91c-14269b734fbe", "Timestamp": "QEA=" }, { "Comment": "sample string 1", "CreatedOn": "2024-05-15T23:12:46Z", "CreatedByID": "63217593-3c90-4528-a6f1-8307c8f7824a", "CreatedBy": "sample string 4", "RequestID": "de69f19d-0ccf-43c4-ade1-9ca971b5c96a", "TaskID": "60afd2ca-1bf6-4fe0-89b1-dfe12880ce2e", "WorkflowActivityID": "9cc77120-20db-463a-9a36-ccb6cf5b3bf4", "WorkflowActivity": "sample string 6", "ID": "5716d5aa-820f-4711-a91c-14269b734fbe", "Timestamp": "QEA=" } ] }
text/javascript
Sample:
{"results":[{"Comment":"sample string 1","CreatedOn":"2024-05-15T23:12:46Z","CreatedByID":"63217593-3c90-4528-a6f1-8307c8f7824a","CreatedBy":"sample string 4","RequestID":"de69f19d-0ccf-43c4-ade1-9ca971b5c96a","TaskID":"60afd2ca-1bf6-4fe0-89b1-dfe12880ce2e","WorkflowActivityID":"9cc77120-20db-463a-9a36-ccb6cf5b3bf4","WorkflowActivity":"sample string 6","ID":"5716d5aa-820f-4711-a91c-14269b734fbe","Timestamp":"QEA="},{"Comment":"sample string 1","CreatedOn":"2024-05-15T23:12:46Z","CreatedByID":"63217593-3c90-4528-a6f1-8307c8f7824a","CreatedBy":"sample string 4","RequestID":"de69f19d-0ccf-43c4-ade1-9ca971b5c96a","TaskID":"60afd2ca-1bf6-4fe0-89b1-dfe12880ce2e","WorkflowActivityID":"9cc77120-20db-463a-9a36-ccb6cf5b3bf4","WorkflowActivity":"sample string 6","ID":"5716d5aa-820f-4711-a91c-14269b734fbe","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">5716d5aa-820f-4711-a91c-14269b734fbe</ID> <Timestamp xmlns="http://schemas.datacontract.org/2004/07/Lpp.Objects">QEA=</Timestamp> <Comment>sample string 1</Comment> <CreatedBy>sample string 4</CreatedBy> <CreatedByID>63217593-3c90-4528-a6f1-8307c8f7824a</CreatedByID> <CreatedOn xmlns:d3p1="http://schemas.datacontract.org/2004/07/System"> <d3p1:DateTime>2024-05-16T03:12:46.8828409Z</d3p1:DateTime> <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes> </CreatedOn> <RequestID>de69f19d-0ccf-43c4-ade1-9ca971b5c96a</RequestID> <TaskID>60afd2ca-1bf6-4fe0-89b1-dfe12880ce2e</TaskID> <WorkflowActivity>sample string 6</WorkflowActivity> <WorkflowActivityID>9cc77120-20db-463a-9a36-ccb6cf5b3bf4</WorkflowActivityID> </WFCommentDTO> <WFCommentDTO> <ID xmlns="http://schemas.datacontract.org/2004/07/Lpp.Objects">5716d5aa-820f-4711-a91c-14269b734fbe</ID> <Timestamp xmlns="http://schemas.datacontract.org/2004/07/Lpp.Objects">QEA=</Timestamp> <Comment>sample string 1</Comment> <CreatedBy>sample string 4</CreatedBy> <CreatedByID>63217593-3c90-4528-a6f1-8307c8f7824a</CreatedByID> <CreatedOn xmlns:d3p1="http://schemas.datacontract.org/2004/07/System"> <d3p1:DateTime>2024-05-16T03:12:46.8828409Z</d3p1:DateTime> <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes> </CreatedOn> <RequestID>de69f19d-0ccf-43c4-ade1-9ca971b5c96a</RequestID> <TaskID>60afd2ca-1bf6-4fe0-89b1-dfe12880ce2e</TaskID> <WorkflowActivity>sample string 6</WorkflowActivity> <WorkflowActivityID>9cc77120-20db-463a-9a36-ccb6cf5b3bf4</WorkflowActivityID> </WFCommentDTO> </ArrayOfWFCommentDTO>