Rate Relationship
This operation rates a relations object from a tenant.
Request:
POST {TenantURL}/{relation 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 the result of the operation. Result contains:
-
status
- result of operation; possible values areOK
orfailed
. -
error
- if operation cannot be completed for some reason. Contains details of the problem.
Example:
Request:
POST {TenantURL}/relations/r1/rate
Headers: Authorization: Bearer 204938ca-2cf7-44b0-b11a-1b4c59984512
{
"confidence" : 5,
"value" : 1,
"comment" : "Very-very Bad!!!!"
}
Response
POST {TenantURL}/relations/r1/rate
Headers: Authorization: Bearer 204938ca-2cf7-44b0-b11a-1b4c59984512
{
"status": "OK"
}