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

Adds a recommendation for the specified Document.

Request Information

URI Parameters

Name	Description	Type	Additional information
documentKey	DocumentKey for the Document to recommend.	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

Details about the Recommendation.

DocumentRating

Name	Type	Additional information
DocumentKey	globally unique identifier	None.
RatingMode	string	None.
RatedByContact	ContactConcise	None.
RatingValue	decimal number	None.

Response Formats

application/json, text/json

Sample:

{
  "DocumentKey": "fab16369-45fa-4fa9-9208-cc3f51dbfad2",
  "RatingMode": "sample string 2",
  "RatedByContact": {
    "LinkToProfile": "sample string 1",
    "PictureUrl": "sample string 2",
    "ContactKey": "d4fbf15c-125d-4b7a-a682-af8ea79105a6",
    "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": "2025-07-15T22:20:17.8933244Z",
    "UpdatedByContactKey": "bbf25ed5-40d7-4b74-ba95-4bbf26179d1c",
    "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": "2025-07-15T22:20:17.8933244Z"
  },
  "RatingValue": 3.0
}

application/xml, text/xml

Sample:

<DocumentRating xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.ResourceLibrary">
  <DocumentKey>fab16369-45fa-4fa9-9208-cc3f51dbfad2</DocumentKey>
  <RatedByContact xmlns:d2p1="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise">
    <d2p1:AMSDirectoryOptOut>true</d2p1:AMSDirectoryOptOut>
    <d2p1:AgreedToTermsDateTime>2025-07-15T18:20:17.8933244-04:00</d2p1:AgreedToTermsDateTime>
    <d2p1:CompanyLegacyContactKey>sample string 20</d2p1:CompanyLegacyContactKey>
    <d2p1:CompanyName>sample string 12</d2p1:CompanyName>
    <d2p1:CompanyTitle>sample string 13</d2p1:CompanyTitle>
    <d2p1:ContactKey>d4fbf15c-125d-4b7a-a682-af8ea79105a6</d2p1:ContactKey>
    <d2p1:ContactStatusCode>sample string 8</d2p1:ContactStatusCode>
    <d2p1:Designation>sample string 15</d2p1:Designation>
    <d2p1:DisplayName>sample string 6</d2p1:DisplayName>
    <d2p1:EmailAddress>sample string 7</d2p1:EmailAddress>
    <d2p1:FirstName>sample string 4</d2p1:FirstName>
    <d2p1:HLContactMeOptOut>true</d2p1:HLContactMeOptOut>
    <d2p1:HLDirectoryOptOut>true</d2p1:HLDirectoryOptOut>
    <d2p1:InformalName>sample string 17</d2p1:InformalName>
    <d2p1:IsCompany>true</d2p1:IsCompany>
    <d2p1:LargePictureUrl>sample string 24</d2p1:LargePictureUrl>
    <d2p1:LastName>sample string 5</d2p1:LastName>
    <d2p1:LegacyContactKey>sample string 16</d2p1:LegacyContactKey>
    <d2p1:LinkToProfile>sample string 1</d2p1:LinkToProfile>
    <d2p1:MiddleName>sample string 18</d2p1:MiddleName>
    <d2p1:PictureUrl>sample string 2</d2p1:PictureUrl>
    <d2p1:PrefixCode>sample string 9</d2p1:PrefixCode>
    <d2p1:SuffixCode>sample string 14</d2p1:SuffixCode>
    <d2p1:UpdatedByContactKey>bbf25ed5-40d7-4b74-ba95-4bbf26179d1c</d2p1:UpdatedByContactKey>
    <d2p1:UpdatedOn>2025-07-15T18:20:17.8933244-04:00</d2p1:UpdatedOn>
  </RatedByContact>
  <RatingMode>sample string 2</RatingMode>
  <RatingValue>3</RatingValue>
</DocumentRating>