POST api/v1.0/ResourceLibrary/AddComment?documentKey={documentKey}

Add a new Comment to a Document.

Request Information

URI Parameters

Name	Description	Type	Additional information
documentKey	Key of the Document being commented on.	globally unique identifier	Required

Body Parameters

CommentRequest

Name	Description	Type	Additional information
CommentBody		string	None.

Request Formats

application/json, text/json

Sample:

{
  "CommentBody": "sample string 1"
}

application/xml, text/xml

Sample:

<CommentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Request">
  <CommentBody>sample string 1</CommentBody>
</CommentRequest>

Response Information

Resource Description

True if successful.

Comment

Name	Description	Type	Additional 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": "df420525-9c32-474d-a5b2-0205ee92e336",
  "CommentBody": "sample string 2",
  "CommentAuthor": {
    "LinkToProfile": "sample string 1",
    "PictureUrl": "sample string 2",
    "ContactKey": "a157c042-9fb0-4c59-916b-6835d4c1f136",
    "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": "2024-12-26T23:45:21.8905243Z",
    "UpdatedByContactKey": "6061dd87-d19d-4ae3-acc0-0db45567007a",
    "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": "2024-12-26T23:45:21.8905243Z"
  },
  "IsOfficial": true,
  "ItemKey": "4a4414b3-27be-48dc-a135-b6e1291d3fba",
  "CreatedOn": "2024-12-26T23:45:21.8905243Z",
  "UpdatedOn": "2024-12-26T23:45:21.8905243Z"
}

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>2024-12-26T18:45:21.8905243-05:00</AgreedToTermsDateTime>
    <CompanyLegacyContactKey>sample string 20</CompanyLegacyContactKey>
    <CompanyName>sample string 12</CompanyName>
    <CompanyTitle>sample string 13</CompanyTitle>
    <ContactKey>a157c042-9fb0-4c59-916b-6835d4c1f136</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>6061dd87-d19d-4ae3-acc0-0db45567007a</UpdatedByContactKey>
    <UpdatedOn>2024-12-26T18:45:21.8905243-05:00</UpdatedOn>
  </CommentAuthor>
  <CommentBody>sample string 2</CommentBody>
  <CommentKey>df420525-9c32-474d-a5b2-0205ee92e336</CommentKey>
  <CreatedOn>2024-12-26T18:45:21.8905243-05:00</CreatedOn>
  <IsOfficial>true</IsOfficial>
  <ItemKey>4a4414b3-27be-48dc-a135-b6e1291d3fba</ItemKey>
  <UpdatedOn>2024-12-26T18:45:21.8905243-05:00</UpdatedOn>
</Comment>