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 WFCommentDTO

Name	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-14T12:52:17Z",
      "CreatedByID": "eafb4ba9-45dd-4904-828a-dd2775688592",
      "CreatedBy": "sample string 4",
      "RequestID": "e8f1b59d-0ac7-4702-b280-a5bd1b77c4be",
      "TaskID": "e4ef051e-c114-4671-8daa-0545edeb64e1",
      "WorkflowActivityID": "305eaa63-ed83-47f3-95da-e1497fb3d75a",
      "WorkflowActivity": "sample string 6",
      "ID": "0d56f651-6060-46da-9f1c-d217ec01171b",
      "Timestamp": "QEA="
    },
    {
      "Comment": "sample string 1",
      "CreatedOn": "2024-05-14T12:52:17Z",
      "CreatedByID": "eafb4ba9-45dd-4904-828a-dd2775688592",
      "CreatedBy": "sample string 4",
      "RequestID": "e8f1b59d-0ac7-4702-b280-a5bd1b77c4be",
      "TaskID": "e4ef051e-c114-4671-8daa-0545edeb64e1",
      "WorkflowActivityID": "305eaa63-ed83-47f3-95da-e1497fb3d75a",
      "WorkflowActivity": "sample string 6",
      "ID": "0d56f651-6060-46da-9f1c-d217ec01171b",
      "Timestamp": "QEA="
    }
  ]
}

text/javascript

Sample:

{"results":[{"Comment":"sample string 1","CreatedOn":"2024-05-14T12:52:17Z","CreatedByID":"eafb4ba9-45dd-4904-828a-dd2775688592","CreatedBy":"sample string 4","RequestID":"e8f1b59d-0ac7-4702-b280-a5bd1b77c4be","TaskID":"e4ef051e-c114-4671-8daa-0545edeb64e1","WorkflowActivityID":"305eaa63-ed83-47f3-95da-e1497fb3d75a","WorkflowActivity":"sample string 6","ID":"0d56f651-6060-46da-9f1c-d217ec01171b","Timestamp":"QEA="},{"Comment":"sample string 1","CreatedOn":"2024-05-14T12:52:17Z","CreatedByID":"eafb4ba9-45dd-4904-828a-dd2775688592","CreatedBy":"sample string 4","RequestID":"e8f1b59d-0ac7-4702-b280-a5bd1b77c4be","TaskID":"e4ef051e-c114-4671-8daa-0545edeb64e1","WorkflowActivityID":"305eaa63-ed83-47f3-95da-e1497fb3d75a","WorkflowActivity":"sample string 6","ID":"0d56f651-6060-46da-9f1c-d217ec01171b","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">0d56f651-6060-46da-9f1c-d217ec01171b</ID>
    <Timestamp xmlns="http://schemas.datacontract.org/2004/07/Lpp.Objects">QEA=</Timestamp>
    <Comment>sample string 1</Comment>
    <CreatedBy>sample string 4</CreatedBy>
    <CreatedByID>eafb4ba9-45dd-4904-828a-dd2775688592</CreatedByID>
    <CreatedOn xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-05-14T16:52:17.7416839Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes>
    </CreatedOn>
    <RequestID>e8f1b59d-0ac7-4702-b280-a5bd1b77c4be</RequestID>
    <TaskID>e4ef051e-c114-4671-8daa-0545edeb64e1</TaskID>
    <WorkflowActivity>sample string 6</WorkflowActivity>
    <WorkflowActivityID>305eaa63-ed83-47f3-95da-e1497fb3d75a</WorkflowActivityID>
  </WFCommentDTO>
  <WFCommentDTO>
    <ID xmlns="http://schemas.datacontract.org/2004/07/Lpp.Objects">0d56f651-6060-46da-9f1c-d217ec01171b</ID>
    <Timestamp xmlns="http://schemas.datacontract.org/2004/07/Lpp.Objects">QEA=</Timestamp>
    <Comment>sample string 1</Comment>
    <CreatedBy>sample string 4</CreatedBy>
    <CreatedByID>eafb4ba9-45dd-4904-828a-dd2775688592</CreatedByID>
    <CreatedOn xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-05-14T16:52:17.7416839Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes>
    </CreatedOn>
    <RequestID>e8f1b59d-0ac7-4702-b280-a5bd1b77c4be</RequestID>
    <TaskID>e4ef051e-c114-4671-8daa-0545edeb64e1</TaskID>
    <WorkflowActivity>sample string 6</WorkflowActivity>
    <WorkflowActivityID>305eaa63-ed83-47f3-95da-e1497fb3d75a</WorkflowActivityID>
  </WFCommentDTO>
</ArrayOfWFCommentDTO>