Skip to main content
Sign Out

Welcome to Dell

My Account
  • Place orders quickly and easily
  • View orders and track your shipping status
  • Create and access a list of your products
  • Manage your Dell EMC sites, products, and product-level contacts using Company Administration.
Sign In Create an Account Premier Sign In Partner Program Sign In

Dell Unity™ Family Unisphere® Management REST API Programmer's Guide

PDF

Collection resource

A collection resource occurs in response to a GET collection request that results in a 200 OK HTTP status code. By default, the response body for a list contains the id for all instances in the resource type collection. You can specify additional fields to return by using the ?fields query parameter. You also can limit the amount of data returned by using the ?page, ?per_page, ?filter, and ?compact query parameters.

The following example illustrates the components of a collection resource. It shows a collection resource returned in response to a GET collection request for the alert resource type. In this example, the query returns the id, severity, and description of each alert in the storage system. Paging is set to 10 instances per page. Spaces outside the quoted strings are used for readability, and are not significant.

Request 

GET https://10.245.23.125/api/types/alert/instances
  ?fields=severity,description?per_page=10

Response 

{
  "@base": "https://10.245.23.125/api/types/alert/instances?fields=severity,description
?per_page=10,id&per_page=2000"

Collection base URI and paging specification for this response. All links within this scope use this base URI. The per_page parameter (?per_page=10) specifies 10 instances per page. 

"updated": "2015-11-19T21:18:30.613Z",,

Date and time the response was generated. 

"links": [
     {
       "rel": "self",
       "href": "&page=1"
     }
   ],
A self-link and a set of hyperlinks to the first, previous, and next pages in the list, relative to the page in this response. In JSON, this is called an array. Only the relevant hyperlinks appear, so if you are on page 1, the hyperlink to the previous page does not appear. 
"entries": [
    {
      "@base": "https://10.245.23.125/api/instances/alert",
      "updated": "2015-11-19T21:18:30.613Z",
      "links": [
        {
          "rel": "self",
          "href": "/alert_1"
        }
      ],
      "content": {
        "id": "alert_1",
        "severity": 4,
        "description": "The DNS client configured for the NAS server has faulted.
Contact your service provider."
      }
    },    {
      "@base": "https://10.245.23.125/api/instances/alert",
      "updated": "2015-11-19T21:18:30.613Z",
      "links": [
        {
          "rel": "self",
          "href": "/alert_2"
        }
      ],
      "content": {
        "id": "alert_2",
        "severity": 6,
        "description": "The component is operating normally. No action is required."
      }
    },

List of all instances in the specified collection that meet the request criteria. The response includes the following information for each instance:

  • Instance base URI. This URI uses a different pattern than the collection URI.
  • Date and time the response was generated.
  • Self-link to this resource.
  • Attribute values as a set of name:value pairs.

Using the ?compact=true query parameter suppresses the instance base URI and links.

Rate this content

Accurate
Useful
Easy to understand
Was this article helpful?
0/3000 characters
  Please provide ratings (1-5 stars).
  Please provide ratings (1-5 stars).
  Please provide ratings (1-5 stars).
  Please select whether the article was helpful or not.
  Comments cannot contain these special characters: <>()\