GET Comments/GetDocumentReferencesByRequest?requestID={requestID}&workflowActivityID={workflowActivityID}

Gets document details for all comments associated with the specified request and optionally limited to comments for a specific workflow activity.

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 workflow activity.	globally unique identifier	None.

Body Parameters

None.

Response Information

Resource Description

CommentDocumentReferenceDTOs

Collection of CommentDocumentReferenceDTO

Name	Description	Type	Additional information
CommentID	Identifier of Comment	globally unique identifier	None.
DocumentID	Identifier of Document	globally unique identifier	None.
RevisionSetID	Identifies the Revision set	globally unique identifier	None.
DocumentName	The name of the Document	string	None.
FileName	The name of the File	string	None.

Response Formats

application/json, text/json

Sample:

{
  "results": [
    {
      "CommentID": "ba10abc4-1e2a-43ec-a92b-d427ed1c6ebe",
      "DocumentID": "7cf7f519-b615-402c-96c3-19f66753b881",
      "RevisionSetID": "ad433339-5b7a-42e4-91c1-91385940d0cc",
      "DocumentName": "sample string 2",
      "FileName": "sample string 3"
    },
    {
      "CommentID": "ba10abc4-1e2a-43ec-a92b-d427ed1c6ebe",
      "DocumentID": "7cf7f519-b615-402c-96c3-19f66753b881",
      "RevisionSetID": "ad433339-5b7a-42e4-91c1-91385940d0cc",
      "DocumentName": "sample string 2",
      "FileName": "sample string 3"
    }
  ]
}

text/javascript

Sample:

{"results":[{"CommentID":"ba10abc4-1e2a-43ec-a92b-d427ed1c6ebe","DocumentID":"7cf7f519-b615-402c-96c3-19f66753b881","RevisionSetID":"ad433339-5b7a-42e4-91c1-91385940d0cc","DocumentName":"sample string 2","FileName":"sample string 3"},{"CommentID":"ba10abc4-1e2a-43ec-a92b-d427ed1c6ebe","DocumentID":"7cf7f519-b615-402c-96c3-19f66753b881","RevisionSetID":"ad433339-5b7a-42e4-91c1-91385940d0cc","DocumentName":"sample string 2","FileName":"sample string 3"}]}

application/bson

Sample:

Binary JSON content. See http://bsonspec.org for details.

application/xml, text/xml

Sample:

<ArrayOfCommentDocumentReferenceDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Lpp.Dns.DTO">
  <CommentDocumentReferenceDTO>
    <CommentID>ba10abc4-1e2a-43ec-a92b-d427ed1c6ebe</CommentID>
    <DocumentID>7cf7f519-b615-402c-96c3-19f66753b881</DocumentID>
    <DocumentName>sample string 2</DocumentName>
    <FileName>sample string 3</FileName>
    <RevisionSetID>ad433339-5b7a-42e4-91c1-91385940d0cc</RevisionSetID>
  </CommentDocumentReferenceDTO>
  <CommentDocumentReferenceDTO>
    <CommentID>ba10abc4-1e2a-43ec-a92b-d427ed1c6ebe</CommentID>
    <DocumentID>7cf7f519-b615-402c-96c3-19f66753b881</DocumentID>
    <DocumentName>sample string 2</DocumentName>
    <FileName>sample string 3</FileName>
    <RevisionSetID>ad433339-5b7a-42e4-91c1-91385940d0cc</RevisionSetID>
  </CommentDocumentReferenceDTO>
</ArrayOfCommentDocumentReferenceDTO>