Reference Guide

Response
body
[
{
"id":"A1",
"name":"H0112-appliance-1",
"nodes":
[
{
"id":"N1"
},
{
"id":"N2"
}
]
}
]
Embedded resource types
An embedded resource type describes an instance of nested objects. This resource type is declared in the REST model as a
reference to an object or an array of objects with a special note in its description field.
● Embedded resources cannot be queried without a parent object.
●
Embedded resources always return all fields. These objects do not allow the user to select which fields to return.
Use the following syntax in the select parameter to query an embedded resource type:
...<attribute1>,<attribute2>,<embedded_resource>
NOTE:
Extending the scope of a collection query is not supported for all resources. Resources that do not support this
functionality include a note in their description stating: Filtering on the fields of this embedded resource
is not supported.
Example
Querying the protection data information for a volume
Headers
Accept: application/json
Authorization: <auth_cookie>
Request
https://1.2.3.4/api/rest/volume?select=id,protection_data
Response
body
[
{
"id":"3f6208d1-b325-4901-9fc1-9e82d943b857",
"protection_data":
{
"family_id": "3f6208d1-b325-4901-9fc1-9e82d943b857",
"parent_id": null,
"source_id": null,
"creator_type": "User",
"copy_signature": null,
"source_timestamp": null,
"creator_type_l10n": "User",
"is_app_consistent": null,
"created_by_rule_id": null,
"created_by_rule_name": null,
"expiration_timestamp": null
}
},
{
Querying a resource 33