Expand Parameter

In this article

    The expand query parameter allows you to add embedded property data to a response.

    Embedded property is a property that contains resource representations of the related entities. In Veeam Service Provider Console REST API, these are root entities which usually represent the same object but from a different perspective. For example, organization is the root entity of a company. By including embedded properties in the GET /organizations/companies request, you can receive information both on all company and organizations related to those companies without sending additional requests.

    The following example response demonstrates a collection of company resources with embedded properties included.

    {

     "meta": {

       "pagingInfo": {

         "total": 2,

         "count": 2,

         "offset": 0

       }

     },

     "data": [

       {

         "instanceUid": "27e9cf71-fca4-49d5-85cc-28ebd8c9be80",

         "name": "ExonCo",

         "status": "Active",

         "resellerUid": "c450989d-68fb-4643-82fd-261531e40dae",

         "subscriptionPlanUid": null,

         "permissions": [],

         "isAlarmDetectEnabled": false

         "_embedded": {

           "organization": {

             "instanceUid": "27e9cf71-fca4-49d5-85cc-28ebd8c9be80",

             "name": "ExonCo",

             "alias": "exonco",

             "type": "Company",

             "taxId": "09876",

             "email": "m.lore@exonco.com",

             "phone": "503-254-0212",

             "country": 1,

             "state": 37,

             "city": "Portland",

             "street": "5006 Gateway Road",

             "notes": "",

             "zipCode": 97220,

             "website": "www.exonco.com",

             "companyId": "exonco"

           }

         }

       },

       {

         "instanceUid": "8daff77c-de61-492d-9bf5-685b6aa31950",

         "name": "CJtech",

         "status": "Active",

         "resellerUid": "c450989d-68fb-4643-82fd-261531e40dae",

         "subscriptionPlanUid": "6fd65357-9ac4-49f7-8594-08572cd469bb",

         "permissions": [],

         "isAlarmDetectEnabled": true

         "_embedded": {

           "organization": {

             "instanceUid": "8daff77c-de61-492d-9bf5-685b6aa31950",

             "name": "CJtech",

             "alias": "cjtech",

             "type": "Company",

             "taxId": 65432,

             "email": "t.barb@cjtech.com",

             "phone": "916-336-1534",

             "country": 1,

             "state": 5,

             "city": "Sacramento",

             "street": "3211 Pearl Street",

             "notes": "",

             "zipCode": 95814,

             "website": "www.cjtech.com",

             "companyId": "cjtech"

           }

         }

       }

     ]

    }

    To include embedded property content, provide the name of a root entity as a value of the expand parameter. The following example request returns the root discovery rules of the discovery rules for Microsoft Windows computers.

    GET https://<hostname>:1280/api/v3/discovery/rules/windows?expand=DiscoveryRule

    Expand Parameter Note:

    PATCH HTTP method cannot be performed on embedded properties.