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

The REST API supports the following request parameters:

To use request parameters, append the parameters to the request URI. The first request parameter appended to the URI begins with a ? character. Additional request parameters begin with & instead of ?. You can combine request parameters and can use them in any order. If a request parameter is repeated, all but the last one is ignored.

Example 1

The following request uses a fields query parameter to return the name, and rpm attributes, a filter query parameter to return disk instances that have an RPM of 15000, and a compact query parameter to omit metadata from each instance in the query response. It also sets the with_entrycount query parameter to true, so that the entry count is included in the response data. For readability purposes, this example omits URI encoding for the space character (%20) and % character (%25).

Request

GET api/types/disk/instances?fields=rpm,name&filter=rpm eq 15000&compact=true&with_entrycount=true

Response

 {
  "@base": "https://10.108.53.216/api/types/disk/instances?filter=rpm eq 15000&fields=rpm,name,id&per_page=2000&compact=true",
  "updated": "2015-12-02T21:03:14.446Z",
  "links": [
    {
      "rel": "self",
      "href": "&page=1"
    }
  ],
  "entryCount": 20,
  "entries": [
    {
      "content": {
        "id": "dpe_disk_0",
        "name": "DPE Disk 0",
        "rpm": 15000
      }
    },
    {
      "content": {
        "id": "dpe_disk_1",
        "name": "DPE Disk 1",
        "rpm": 15000
      }
    },
    {
      "content": {
        "id": "dpe_disk_2",
        "name": "DPE Disk 2",
        "rpm": 15000
      }
    },
.
.
.

Example 2

The following request uses the per_page and page query parameters to group returned disk instances into chunks of two instances per page and to return only the instances on page three. It also uses fields query parameter to return the name, pool and tierType attributes, and the compact query parameter to omit metadata from each instance in the query response:

Request

GET api/types/disk/instances?per_page=3&page=2&fields=name,pool,tierType&compact=true

Response

{
  "@base": "https://10.245.23.125/api/types/disk/instances?fields=name,tierType,id,pool.id&per_page=3&compact=true",
  "updated": "2015-11-19T22:47:53.424Z",
  "links": [
    {
      "rel": "self",
      "href": "&page=2"
    }
  ],
  "entries": [
    {
      "content": {
        "id": "dae_0_1_disk_3",
        "tierType": 20,
        "name": "DAE 0 1 Disk 3",
        "pool": {
          "id": "pool_1"
        }
      }
    },
    {
      "content": {
        "id": "dae_0_1_disk_4",
        "tierType": 20,
        "name": "DAE 0 1 Disk 4",
        "pool": {
          "id": "pool_1"
        }
      }
    },
    {
      "content": {
        "id": "dae_0_1_disk_5",
        "tierType": 20,
        "name": "DAE 0 1 Disk 5",
        "pool": {
          "id": "pool_1"
        }
      }
    }
  ]
}