- Notes, cautions, and warnings
- Additional resources
- Welcome
- REST API overview
- JSON request components
- JSON response components
- JSON encodings
- Preparing to make a request
- Querying a resource
- Retrieving data for multiple occurrences in a collection
- Retrieving data for a specified resource instance
- Omitting metadata from responses
- Specifying the attributes to return in a query response
- Paginating response data
- Filtering response data
- Sorting response data
- Aggregating response data
- Defining new attributes from existing attributes
- Extending queries to include related data
- Localizing response text
- Creating other types of requests
- Downloading and uploading files
- Downloading and uploading NAS server configuration files
- Downloading and uploading x.509 certificates
- Downloading configuration capture files
- Downloading service information files
- Downloading import session report files
- Downloading Data at Rest Encryption files
- Uploading upgrade candidates and language packs
- Uploading license files
- Perl example
Dell Unity™ Family Unisphere® Management REST API Programmer's Guide
JSON response body
If a request to the REST API is successful, the JSON response body contains data that represents the requested resources. If a request is unsuccessful, the response body contains a message entity. In both cases, the response body is a set of components enclosed by outer braces, with each component formatted as a name:value pair.
The following table describes the response body components:
| Component | Description |
|---|---|
| "@base" | Name of the base URI. The base URI is used at both the collection level and the instance level. |
| "updated" | Date and time the response was generated. The update time is used at both the collection level and the instance level. |
| "links" | List of one or more hyperlinks. Each hyperlink has two sub-components:
The first hyperlink in a response body is the self-link to the requested resource, which informs users how the data was retrieved. Subsequent hyperlinks in a response body are related URIs that the user can use to retrieve additional information. The hyperlinks are used at both the collection level and the instance level. |
| "entryCount" | Number of instances in the complete list. This component is used at the collection level only, and is only returned if the with_entrycount query parameter is set to true. |
| "entries" | List of all instances in the current page of the specified collection that meet the request criteria. This component is used at the collection level only. |
| "content" | Set of name:value pairs for one resource. Not all requests return name:value pair content. |
The format of a response body depends on how the request was processed and whether the request was successful. The REST API supports the following types of response bodies:
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: <>()\