POST api/v2.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.
DocumentRatingName | Description | 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": "0b8085ca-c27c-49ac-93e2-5926db55406e", "RatingMode": "sample string 2", "RatedByContact": { "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "ContactKey": "dce6ebed-19bf-4b37-954b-f9c6f5fd9190", "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-08T00:53:44.8368179Z", "UpdatedByContactKey": "af94af70-ead9-4aa2-882e-666b1271cd5a", "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-08T00:53:44.8368179Z" }, "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>0b8085ca-c27c-49ac-93e2-5926db55406e</DocumentKey> <RatedByContact xmlns:d2p1="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise"> <d2p1:AMSDirectoryOptOut>true</d2p1:AMSDirectoryOptOut> <d2p1:AgreedToTermsDateTime>2024-09-07T20:53:44.8368179-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>dce6ebed-19bf-4b37-954b-f9c6f5fd9190</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>af94af70-ead9-4aa2-882e-666b1271cd5a</d2p1:UpdatedByContactKey> <d2p1:UpdatedOn>2024-09-07T20:53:44.8368179-04:00</d2p1:UpdatedOn> </RatedByContact> <RatingMode>sample string 2</RatingMode> <RatingValue>3</RatingValue> </DocumentRating>