GET v1/project/{proj_id}/comments

Return all comments for the given project.

Request Information

Parameters

NameDescriptionAdditional information
proj_id
Get project IDs by calling ~/projects

Define this parameter in the request URI.

Response Information

An array of comments

Response body formats

application/json, text/json

Sample:
[
  {
    "ParentItem": {
      "ItemID": "sample string 1",
      "Name": "sample string 2",
      "Url": "sample string 3",
      "Api": "sample string 4"
    },
    "ID": 1,
    "Author": "sample string 2",
    "Created": "2024-04-23T09:25:29.7217086+00:00",
    "Text": "sample string 4"
  },
  {
    "ParentItem": {
      "ItemID": "sample string 1",
      "Name": "sample string 2",
      "Url": "sample string 3",
      "Api": "sample string 4"
    },
    "ID": 1,
    "Author": "sample string 2",
    "Created": "2024-04-23T09:25:29.7217086+00:00",
    "Text": "sample string 4"
  }
]

application/xml, text/xml

Sample:
<ArrayOfComment xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Comment>
    <ID>1</ID>
    <Author>sample string 2</Author>
    <Created>2024-04-23T09:25:29.7217086+00:00</Created>
    <Text>sample string 4</Text>
    <ParentItem>
      <ItemID>sample string 1</ItemID>
      <Name>sample string 2</Name>
      <Url>sample string 3</Url>
      <Api>sample string 4</Api>
    </ParentItem>
  </Comment>
  <Comment>
    <ID>1</ID>
    <Author>sample string 2</Author>
    <Created>2024-04-23T09:25:29.7217086+00:00</Created>
    <Text>sample string 4</Text>
    <ParentItem>
      <ItemID>sample string 1</ItemID>
      <Name>sample string 2</Name>
      <Url>sample string 3</Url>
      <Api>sample string 4</Api>
    </ParentItem>
  </Comment>
</ArrayOfComment>