Unsubscribe a user from a series
delete
/rhp-restapi/rhp/series/{seriesId}/users/{userId}
Removes an existing user from the subscribed users list for an existing series.
Request
Supported Media Types
- application/json
Path Parameters
-
seriesId(required): string
Name of the series.
-
userId(required): string
OS user name.
Response
Supported Media Types
- application/json
- text/html
200 Response
OK. A JSON object containing a series resource representation with multiple properties and the links array with at least the "self" link.
Nested Schema : singleResourceLinks
Type:
Show Source
object
-
href:
string
The referenced hyperlink element provided in an absolute format.
-
rel:
string
Allowed Values:
[ "self", "collection", "up", "describedBy" ]
Specify the type of relationship the link has with the described resource.
Default Response
Unexpected error. A JSON object containing error details of the issue while executing the operation.
Root Schema : errorResource
Type:
Show Source
object
-
errorCode:
string
Application specific error code, related to the error message shown at tittle.
-
errorDetails:
array errorDetails
If multiple errors are reported they can be organized in a hierarchical structure in this array.
-
errorPath:
string
XPath or JSON path to indicate where the error occurs.
-
instance:
string
URI to the link that provides more detail about the error.
-
status:
integer
HTTP status code.
-
title:
string
Summary error message.
-
type:
string
Link to HTTP error code page.
Nested Schema : errorDetails
Type:
array
If multiple errors are reported they can be organized in a hierarchical structure in this array.
Show Source
Examples
The following example shows how to remove a user from the subscribers of an image series by submitting a DELETE request on the REST resource using cURL.
curl -u restUser -X DELETE -H "Content-Type: application/json" "https://RHP_node_name:8894/rhp-restapi/rhp/series/CRM_DB_Serie1/users/grid"
HTTP Status Code and Response Headers
The following shows an example of the response header.
HTTP/1.1 200
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Access-Control-Allow-Methods: GET,PUT,POST,DELETE,PATCH,OPTIONS
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Content-Length, Authorization
Connection: keep-alive
Content-Type: application/json
Content-Length: 251
Date: Tue, 19 Jun 2018 14:03:23 GMT
Response Body
{
"seriesId": "CRM_DB_Serie1",
"imageNames": ["DB_Image1", "DB_Image2"],
"subscribedUsers": [ "oracle"],
"links": [{
"uri": "https://RHP_node_name:8894/rhp-restapi/rhp/series/CRM_DB_Serie1",
"rel": "self"
}]
}