Chatter REST API Developer's Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Scheduled Recommendation Input

A scheduled recommendation.
JSON example for creating a new scheduled recommendation
1{
2   "rank" : "2",
3   "recommendationDefinitionId" : "0RDD00000004CEhOAM"}
JSON example for updating an existing scheduled recommendation
1{   "rank" : "2"}
Properties
Name Type Description Required or Optional Available Version
rank Integer Relative rank of the scheduled recommendation indicated by ascending whole numbers starting with 1.

Setting the rank is comparable to an insertion into an ordered list. The scheduled recommendation is inserted into the position specified by the rank. The rank of all the scheduled recommendations after it is pushed down. See Ranking scheduled recommendations example.

If the specified rank is larger than the size of the list, the scheduled recommendation is put at the end of the list, and the rank of the scheduled recommendation is the size of the list, instead of the one specified.

If a rank is not specified, the scheduled recommendation is put at the end of the list.

 Optional 33.0
recommendation​DefinitionId String ID of the recommendation definition that is scheduled by this scheduled recommendation. Required for creating a new scheduled recommendation.

You can’t specify a recommendation​DefinitionId when updating an existing scheduled recommendation.

 33.0
Ranking scheduled recommendations example

If you have these scheduled recommendations:

Scheduled Recommendations Rank
ScheduledRecommendationA 1
ScheduledRecommendationB 2
ScheduledRecommendationC 3

And you include this information in the Scheduled Recommendation Input:

Scheduled Recommendation Rank
ScheduledRecommendationD 2

The result is:

Scheduled Recommendation Rank
ScheduledRecommendationA 1
ScheduledRecommendationD 2
ScheduledRecommendationB 3
ScheduledRecommendationC 4