Search series matching certain parameters

get

/series/search

Returns a list of the series that matches either the name of the image or the server provided.

Request

Supported Media Types
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

OK. A JSON object containing an "items" property populated with 0 or more elements with at least an Id property and the links array with at least the "self" link.
Body ()
Root Schema : arrayOfItems
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : singleResource
Type: object
Show Source

Default Response

Unexpected error. A JSON object containing error details of the issue while executing the operation.
Body ()
Root Schema : errorResource
Type: object
Show Source
Nested Schema : errorDetails
Type: array
If multiple errors are reported they can be organized in a hierarchical structure in this array.
Show Source
Back to Top

Examples

The following example shows how to search all image series that contain a specific image by submitting a GET request on the REST resource using cURL.

curl -u restUser -X GET "https://RHP_node_name:8894/rhp-restapi/rhp/series/search?image=DB_Image1" 	

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: 235
Date:  Tue, 19 Jun 2018 14:03:23 GMT

Response Body

{
  "items": [
    {
      "seriesId": "CRM_DB_Serie1",
      "links": [{
                      "uri": "https://RHP_node_name:8894/rhp-restapi/rhp/series/CRM_DB_Serie1",
                      "rel": "self"
          }
      ]
    }
  ]
}
Back to Top