Property Filter

When retrieving information using GET, you can specify the query parameters, or "fields", to select what properties to retrieve.

In the "fields" query parameter, specify the properties to display in a comma separated list (",") as follows.

If "fields" is not specified, all properties are obtained.

Example:

https://192.168.1.1:5665/api/v1/volume?fields=name,status

The resource ID ({Resource Name}_id) is returned regardless of whether the Resource ID is specified in fields.

If you want to extract the information that is responded in list form, specify the parameter name in the list. For example, if you only want the Volume Name information with GET /volume, specify fields=name, not fields=volume_list.name.

Basically, all the parameter names that are returned in the response body can be specified in the fields, but the following parameter names cannot be specified in the fields. In this case, regardless of whether fields are specified, the information of the parameter is returned when the condition is satisfied.

• Parameter names that do not support responses.

• The following parameter names:

  • total_count

  • list_count

  • next_href

• The object name ({Resource Name}_list) of the resource used for the API command name.

  For example, GET /tpp?fields=tpp_list is not available. On the other hand, GET /tpp?fields=raidgroup_list is available.