GET api/v2.0/Comments/Get?commentKey={commentKey}

Returns the details of the specified Comment.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
commentKey

unique identifier of a specific Comment

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

The details of the specified Comment

Comment
NameDescriptionTypeAdditional information
CommentKey

The unique identifier for the comment

globally unique identifier

None.

CommentBody

The text body of the comment

string

None.

CommentAuthor

Metadata pertaining to the user who created the comment

ContactConcise

None.

IsOfficial

A single comment for an item can be marked as the official comment, and is generally displayed as the top comment/pinned.

boolean

None.

ItemKey

The unique identifier for the comment's parent content item

globally unique identifier

None.

CreatedOn

The date that the comment was created

date

None.

UpdatedOn

The date that the comment was last updated

date

None.

Response Formats

application/json, text/json

Sample:
{
  "CommentKey": "8d1abba2-0f1f-4b0a-aab3-010f4b011539",
  "CommentBody": "sample string 2",
  "CommentAuthor": {
    "LinkToProfile": "sample string 1",
    "PictureUrl": "sample string 2",
    "ContactKey": "19f13384-341b-4eb5-8e6f-5b56fcc16984",
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "DisplayName": "sample string 6",
    "EmailAddress": "sample string 7",
    "ContactStatusCode": "sample string 8",
    "PrefixCode": "sample string 9",
    "UpdatedOn": "2021-09-25T12:29:34.230992Z",
    "UpdatedByContactKey": "0aceac10-2cb7-4bba-a806-170dd7c9796f",
    "CompanyName": "sample string 12",
    "CompanyTitle": "sample string 13",
    "SuffixCode": "sample string 14",
    "Designation": "sample string 15",
    "LegacyContactKey": "sample string 16",
    "InformalName": "sample string 17",
    "MiddleName": "sample string 18",
    "IsCompany": true,
    "CompanyLegacyContactKey": "sample string 20",
    "AMSDirectoryOptOut": true,
    "HLDirectoryOptOut": true,
    "HLContactMeOptOut": true,
    "LargePictureUrl": "sample string 24",
    "AgreedToTermsDateTime": "2021-09-25T12:29:34.230992Z"
  },
  "IsOfficial": true,
  "ItemKey": "bff5471a-526b-4d3f-a521-984938653e7c",
  "CreatedOn": "2021-09-25T12:29:34.230992Z",
  "UpdatedOn": "2021-09-25T12:29:34.230992Z"
}

application/xml, text/xml

Sample:
<Comment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise">
  <CommentAuthor>
    <AMSDirectoryOptOut>true</AMSDirectoryOptOut>
    <AgreedToTermsDateTime>2021-09-25T08:29:34.230992-04:00</AgreedToTermsDateTime>
    <CompanyLegacyContactKey>sample string 20</CompanyLegacyContactKey>
    <CompanyName>sample string 12</CompanyName>
    <CompanyTitle>sample string 13</CompanyTitle>
    <ContactKey>19f13384-341b-4eb5-8e6f-5b56fcc16984</ContactKey>
    <ContactStatusCode>sample string 8</ContactStatusCode>
    <Designation>sample string 15</Designation>
    <DisplayName>sample string 6</DisplayName>
    <EmailAddress>sample string 7</EmailAddress>
    <FirstName>sample string 4</FirstName>
    <HLContactMeOptOut>true</HLContactMeOptOut>
    <HLDirectoryOptOut>true</HLDirectoryOptOut>
    <InformalName>sample string 17</InformalName>
    <IsCompany>true</IsCompany>
    <LargePictureUrl>sample string 24</LargePictureUrl>
    <LastName>sample string 5</LastName>
    <LegacyContactKey>sample string 16</LegacyContactKey>
    <LinkToProfile>sample string 1</LinkToProfile>
    <MiddleName>sample string 18</MiddleName>
    <PictureUrl>sample string 2</PictureUrl>
    <PrefixCode>sample string 9</PrefixCode>
    <SuffixCode>sample string 14</SuffixCode>
    <UpdatedByContactKey>0aceac10-2cb7-4bba-a806-170dd7c9796f</UpdatedByContactKey>
    <UpdatedOn>2021-09-25T08:29:34.230992-04:00</UpdatedOn>
  </CommentAuthor>
  <CommentBody>sample string 2</CommentBody>
  <CommentKey>8d1abba2-0f1f-4b0a-aab3-010f4b011539</CommentKey>
  <CreatedOn>2021-09-25T08:29:34.230992-04:00</CreatedOn>
  <IsOfficial>true</IsOfficial>
  <ItemKey>bff5471a-526b-4d3f-a521-984938653e7c</ItemKey>
  <UpdatedOn>2021-09-25T08:29:34.230992-04:00</UpdatedOn>
</Comment>