Rate Entity
Add an entity rating.
This operation adds rating for an entity.
Request
POST {TenantURL}/{entity object URI}/rate| Parameter | Required | Details | |
|---|---|---|---|
| Headers | Authorization |
Yes | Information about authentication access token in format "Bearer
<accessToken>" (see details in Authentication API). |
| Body | Yes | JSON specifying the rating value. | |
| Attribute name | Details |
|---|---|
value
|
Rating value |
comment
|
Comment applied with rating |
Response
JSON Object representing result of a rate operation. Result contains:
status- result of operation; possible values are "OK" or "failed"error- if object cannot be rated for some reason. Contains details of the problem. Returned only if an object was not rated.
Request
POST {TenantURL}/entities/e1/rate
Headers: Authorization: Bearer 204938ca-2cf7-44b0-b11a-1b4c59984512
{
"value" : 5,
"comment" : "Good"
}Response
POST {TenantURL}/entities/e1/rate
Headers: Authorization: Bearer 204938ca-2cf7-44b0-b11a-1b4c59984512
{
"status": "OK"
}