Features for recommending resources
The Files CMIS API introduces the following features to enable the ability to manage recommendations on select resources.
Feature key Feature value recommendable true or false
This feature introduces the following service operation to the domain model:applyRecommendation
- Applies a recommendation record for the requesting user on the specified resource. This service must be supported by a repository if the object type of the object with the specified id supports the recommendable feature.
- Required inputs
- ID repositoryId: The identifier for the repository.
- ID objectId: The identifier for the object
- Boolean recommended
- TRUE: indicates that the client requests to recommend the specified resource.
- FALSE: indicates that the client does not want to recommend the specified resource.
- Outputs
- Recommendation: The updated recommendation record for the requesting user.
- Exceptions thrown and conditions
getRecommendation
- Gets a recommendation record for the requesting user on the specified resource. This service must be supported by a repository if the object type of the object with the specified id supports the recommendable feature.
- Required inputs
- ID repositoryId: The identifier for the repository.
- ID objectId: The identifier for the object.
- Outputs
- Recommendation: The recommendation record for the requesting user.
- Exceptions thrown and conditions
getRecommendations
- Gets a list of recommendation records on the specified resource. This service must be supported by a repository if the object type of the object with the specified id supports the recommendable feature.
- Required inputs:
- ID repositoryId: The identifier for the repository.
- ID objectId: The identifier for the object
- Outputs
- <Array> Recommendation: The recommendation records for the resource
- Exceptions thrown and conditions
This feature introduces the following extensions to the Restful Atompub Binding:
Document entry
Link relations:
- http://www.ibm.com/xmlns/prod/sn/cmis/recommendation: Points to the recommendation record for this document for authenticated users.
- GET
- getRecommendation
- PUT
- applyRecommendation
- http://www.ibm.com/xmlns/prod/sn/cmis/recommendations: Points to the recommendations resource for this document that lists all recommendations on the resource.
- GET
- getRecommendations
Parent topic
Files CMIS API features
});