POST api/v2.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	Type	Additional information
CommentBody	string	None.
CommentAuthor	ContactConcise	None.
CreatedOn	date	None.
CommentKey	globally unique identifier	None.
UpdatedOn	date	None.

Response Formats

application/json, text/json

Sample:

{
  "CommentBody": "sample string 1",
  "CommentAuthor": {
    "LinkToProfile": "sample string 1",
    "PictureUrl": "sample string 2",
    "ContactKey": "4a61af34-a8d9-4211-b3f7-ef022bbda7c7",
    "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": "2020-02-16T23:41:57.1462371Z",
    "UpdatedByContactKey": "43d0b540-8457-4d87-869a-2180d820a2f1",
    "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": "2020-02-16T23:41:57.1462371Z"
  },
  "CreatedOn": "2020-02-16T23:41:57.1462371Z",
  "CommentKey": "c986b66d-6960-4fa5-b330-04a930ad4f02",
  "UpdatedOn": "2020-02-16T23:41:57.1462371Z"
}

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>2020-02-16T18:41:57.1462371-05:00</AgreedToTermsDateTime>
    <CompanyLegacyContactKey>sample string 20</CompanyLegacyContactKey>
    <CompanyName>sample string 12</CompanyName>
    <CompanyTitle>sample string 13</CompanyTitle>
    <ContactKey>4a61af34-a8d9-4211-b3f7-ef022bbda7c7</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>43d0b540-8457-4d87-869a-2180d820a2f1</UpdatedByContactKey>
    <UpdatedOn>2020-02-16T18:41:57.1462371-05:00</UpdatedOn>
  </CommentAuthor>
  <CommentBody>sample string 1</CommentBody>
  <CommentKey>c986b66d-6960-4fa5-b330-04a930ad4f02</CommentKey>
  <CreatedOn>2020-02-16T18:41:57.1462371-05:00</CreatedOn>
  <UpdatedOn>2020-02-16T18:41:57.1462371-05:00</UpdatedOn>
</Comment>