Model Information REST API | Description |
---|---|
GET data/objects/{id}/reviews | Lists the reviews and ratings for an object |
POST data/objects/{id}/reviews | Creates a review for an object |
GET data/objects/{id}/reviews/{reviewId} | Lists the reviews and ratings for a specific review |
PUT data/objects/{id}/reviews/{reviewId} | Updates a specific review |
DELETE data/objects/{id}/reviews/{reviewId} | Deletes a specific review |
GET data/objects/{id}/reviews/{reviewId}/vote | Lists aggregated votes for a review |
POST data/objects/{id}/reviews/{reviewId}/vote | Creates a vote for a review |
DELETE data/objects/{id}/reviews/{reviewId}/vote | Deletes a vote for a review |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/data/objects/{id}/reviews |
HTTP Method Type | GET |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
id | Required | The ID of the data object. | Path | String |
userFilter | Optional | Choose one of the following user-based filter parameters:
| Query | String |
ratingFilter | Optional | Choose one of the following rating filters:
| Query | String |
sortOn | Optional | Choose one of the following parameters to sort comments:
| Query | String |
offset | Optional | The offset position from which the API lists the results. Default is 0. | Query | Integer |
pageSize | Optional | The number of results to be display in a page. Default is 20. | Query | Integer |
Code | Reason |
---|---|
200 | Returned all reviews and ratings on single object. |
400 | Missing or invalid parameter. |
401 | Missing credentials. |
403 | User does not have the required access permissions. |
404 | Requested object not found. |
429 | Rate limit for requests encountered. |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/data/objects/{id}/reviews |
HTTP Method Type | POST |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
id | Required | The ID of the data object. | Path | String |
object | Required | Enter the following review options:
| Body | - |
Code | Reason |
---|---|
201 | Created a review for the specified data object. |
400 | Missing or invalid parameter. |
401 | Missing credentials. |
403 | User does not have the required access permissions. |
404 | Requested object not found. |
412 | Conflicting edit detected. |
429 | Rate limit for requests encountered. |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/data/objects/{id}/reviews/{reviewId} |
HTTP Method Type | GET |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
id | Required | The ID of the data object. | Path | String |
reviewId | Required | The ID of the review. | Path | String |
Code | Reason |
---|---|
200 | Review object. |
400 | Missing or invalid parameter. |
401 | Missing credentials. |
403 | User does not have the required access permissions. |
404 | Requested object not found. |
429 | Rate limit for requests encountered. |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/data/objects/{id}/reviews/{reviewId} |
HTTP Method Type | PUT |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
id | Required | The ID of a data object. | Path | String |
reviewId | Required | The ID of a review. | Path | String |
object | Required | Enter the following review options:
| Body | - |
If-Match | Optional | Identify the ETag for the resource. Enterprise Data Catalog does not update the resource if the ETag for the resource has changed. | Header | String |
Code | Reason |
---|---|
201 | Updated the review. |
400 | Missing or invalid parameter. |
401 | Missing credentials. |
403 | User does not have the required access permissions. |
404 | Requested object not found. |
412 | Conflicting edit detected. |
429 | Rate limit for requests encountered. |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/data/objects/{id}/reviews/{reviewId} |
HTTP Method Type | DELETE |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
id | Required | The ID of the data object. | Path | String |
reviewId | Required | The ID of the review. | Path | String |
Code | Reason |
---|---|
200 | Deleted reviews and ratings for the data object. |
204 | No content to display. |
400 | Missing or invalid parameter. |
401 | Missing credentials. |
403 | User does not have the required access permissions. |
404 | Requested object not found. |
412 | Conflicting edit detected. |
429 | Rate limit for requests encountered. |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/data/objects/{id}/reviews/{reviewId}/vote |
HTTP Method Type | GET |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
id | Required | The ID of the data object. | Path | String |
reviewId | Required | The ID of the review. | Path | String |
Code | Reason |
---|---|
200 | Listed the votes for the specified review. |
400 | Missing or invalid parameter. |
401 | Missing credentials. |
403 | User does not have the required access permissions. |
404 | Requested object not found. |
429 | Rate limit for requests encountered. |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/data/objects/{id}/reviews/{reviewId}/vote |
HTTP Method Type | POST |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
id | Required | The ID of the data object. | Path | String |
reviewId | Required | The ID of a review. | Path | String |
object | Required | Enter HELPFUL or NOT_HELPFUL as voteKind. | Body | - |
Code | Reason |
---|---|
200 | Upvote on comment. |
201 | Created a vote for the specified review successfully. |
400 | Missing or invalid parameter. |
401 | Missing credentials. |
403 | User does not have the required access permissions. |
404 | Requested object not found. |
412 | Conflicting edit detected. |
429 | Rate limit for requests encountered. |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/data/objects/{id}/reviews/{reviewId}/vote |
HTTP Method Type | DELETE |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
id | Required | The ID of the data object. | Path | String |
reviewId | Required | The ID of the review. | Path | String |
Code | Reason |
---|---|
200 | Deleted the votes for the specified review. |
204 | No content to display. |
400 | Missing or invalid parameter. |
401 | Missing credentials. |
403 | User does not have the required access permissions. |
404 | Requested object not found. |
412 | Conflicting edit detected. |
429 | Rate limit for requests encountered. |