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

Add a new Comment to a Document.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
documentKey

Key of the Document being commented on.

globally unique identifier

Required

Body Parameters

CommentRequest
NameDescriptionTypeAdditional 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
NameDescriptionTypeAdditional 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": "f8ed0028-f5c1-47a5-8fda-8e276ef1f434",
    "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": "2019-07-21T08:27:19.251793Z",
    "UpdatedByContactKey": "434e34af-62b4-4325-8a0c-d295d5a475a7",
    "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": "2019-07-21T08:27:19.251793Z"
  },
  "CreatedOn": "2019-07-21T08:27:19.251793Z",
  "CommentKey": "47484f99-4d0b-4b3b-bb69-ce15fbf1c05d",
  "UpdatedOn": "2019-07-21T08:27:19.251793Z"
}

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>2019-07-21T04:27:19.251793-04:00</AgreedToTermsDateTime>
    <CompanyLegacyContactKey>sample string 20</CompanyLegacyContactKey>
    <CompanyName>sample string 12</CompanyName>
    <CompanyTitle>sample string 13</CompanyTitle>
    <ContactKey>f8ed0028-f5c1-47a5-8fda-8e276ef1f434</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>434e34af-62b4-4325-8a0c-d295d5a475a7</UpdatedByContactKey>
    <UpdatedOn>2019-07-21T04:27:19.251793-04:00</UpdatedOn>
  </CommentAuthor>
  <CommentBody>sample string 1</CommentBody>
  <CommentKey>47484f99-4d0b-4b3b-bb69-ce15fbf1c05d</CommentKey>
  <CreatedOn>2019-07-21T04:27:19.251793-04:00</CreatedOn>
  <UpdatedOn>2019-07-21T04:27:19.251793-04:00</UpdatedOn>
</Comment>