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
CommentRequestName | 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.
CommentName | 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": "60e23573-81a9-4b75-b51d-7ea4a500ed66", "CommentBody": "sample string 2", "CommentAuthor": { "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "ContactKey": "a489dbbc-8d83-452f-9c3e-9a3cf1e69522", "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-09-08T02:44:25.8418309Z", "UpdatedByContactKey": "678dc8fe-370b-4ccf-b8b1-23369cc084b9", "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-09-08T02:44:25.8418309Z" }, "IsOfficial": true, "ItemKey": "1897473a-ae95-4ba7-bb47-b77f1bbb43fc", "CreatedOn": "2024-09-08T02:44:25.8418309Z", "UpdatedOn": "2024-09-08T02:44:25.8418309Z" }
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-09-07T22:44:25.8418309-04:00</AgreedToTermsDateTime> <CompanyLegacyContactKey>sample string 20</CompanyLegacyContactKey> <CompanyName>sample string 12</CompanyName> <CompanyTitle>sample string 13</CompanyTitle> <ContactKey>a489dbbc-8d83-452f-9c3e-9a3cf1e69522</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>678dc8fe-370b-4ccf-b8b1-23369cc084b9</UpdatedByContactKey> <UpdatedOn>2024-09-07T22:44:25.8418309-04:00</UpdatedOn> </CommentAuthor> <CommentBody>sample string 2</CommentBody> <CommentKey>60e23573-81a9-4b75-b51d-7ea4a500ed66</CommentKey> <CreatedOn>2024-09-07T22:44:25.8418309-04:00</CreatedOn> <IsOfficial>true</IsOfficial> <ItemKey>1897473a-ae95-4ba7-bb47-b77f1bbb43fc</ItemKey> <UpdatedOn>2024-09-07T22:44:25.8418309-04:00</UpdatedOn> </Comment>