Expand Parameter
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 companies 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": "eb866e8f-a0f5-41f4-9dd9-8cc59266ff25", "name": "Alpha", "status": "Active", "resellerUid": "a1797b02-364e-4e31-b052-7d7db48edb4a", "subscriptionPlanUid": "615808c7-12ba-4cd4-a1c2-3ba78d95fbe9", "isRestAccessEnabled": true, "isAlarmDetectEnabled": true, "companyServices": { "hostedServices": { "isVbPublicCloudManagementEnabled": false }, "remoteServices": { "isBackupResourcesEnabled": true, "backupAgentsManagement": { "workstationAgentsQuota": 20, "serverAgentsQuota": 20 }, "backupServersManagement": { "backupServerQuota": 20 }, "vb365ServersManagement": null, "isVbPublicCloudManagementEnabled": false } }, "loginUrl": null, "ownerCredentials": { "userName": "alphauser", "password": null }, "_embedded": { "organization": { "instanceUid": "ece6d725-2fc2-48e6-af85-b78b3778b63c", "name": "Alpha", "alias": "alpha", "type": "Company", "taxId": "65432", "email": "t.barb@alpha.com", "phone": "916-336-1534", "country": 1, "state": 5, "countryName": "USA", "regionName": "West", "city": "Sacramento", "street": "Awesome street", "locationAdmin0Code": "us", "locationAdmin1Code": "us-ca", "locationAdmin2Code": null, "notes": "", "zipCode": "95814", "website": "www.alpha.com", "veeamTenantId": "10" } } }, { "instanceUid": "279595ca-2027-4110-abc8-63619d14e25a", "name": "Beta", "status": "Active", "resellerUid": "a1797b02-364e-4e31-b052-7d7db48edb4a", "subscriptionPlanUid": null, "isRestAccessEnabled": true, "isAlarmDetectEnabled": false, "companyServices": { "hostedServices": { "isVbPublicCloudManagementEnabled": false }, "remoteServices": { "isBackupResourcesEnabled": true, "backupAgentsManagement": { "workstationAgentsQuota": 20, "serverAgentsQuota": 20 }, "backupServersManagement": { "backupServerQuota": 20 }, "vb365ServersManagement": null, "isVbPublicCloudManagementEnabled": false } }, "loginUrl": null, "ownerCredentials": { "userName": "betauser", "password": null }, "_embedded": { "organization": { "instanceUid": "61a6c733-d6a9-4540-9698-1d4e3c6bdaab", "name": "Beta", "alias": "beta", "type": "Company", "taxId": "09876", "email": "m.lore@beta.com", "phone": "503-254-0212", "country": 1, "state": 37, "countryName": "USA", "regionName": "West", "city": "Portland", "street": "5006 Gateway Road", "locationAdmin0Code": "us", "locationAdmin1Code": "us-or", "locationAdmin2Code": null, "notes": "", "zipCode": "97220", "website": "www.beta.com", "veeamTenantId": "2" } } } ] } |
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 |
|
PATCH HTTP method cannot be performed on embedded properties. |
