VMware Cloud Director API - GET-OrganizationsFromQuery
GET /admin/orgs/query
- Operation:
- GET /admin/orgs/query
- Description:
- Retrieves a list of organizations by using REST API general QueryHandler; If filter is provided it will be applied to the corresponding result set. Format determines the elements representation - references or records. Default format is references.
- Since:
- 1.5
- Deprecated:
- 38.1
- Input parameters
-
- Consume media type(s):
- None
- Input type:
- None
- Query parameters
-
- Parameter
- filter
- Documentation
- Parameter
- sortAsc
- Documentation
- Parameter
- sortDesc
- Documentation
- Parameter
- format
- Documentation
- Parameter
- page
- Documentation
- Parameter
- pageSize
- Documentation
- Parameter
- offset
- Documentation
- Parameter
- fields
- Documentation
- Parameter
- links
- Documentation
- Output parameters
-
Returns OkResponse
- Produce media type(s):
-
application/vnd.vmware.vcloud.query.records+xml
application/vnd.vmware.vcloud.query.records+json
application/vnd.vmware.vcloud.query.idrecords+xml
application/vnd.vmware.vcloud.query.idrecords+json
application/vnd.vmware.vcloud.query.references+xml
application/vnd.vmware.vcloud.query.references+json
- Output type:
- ContainerType
- Examples
-
- Request
-
HTTP 1.1
GET /api/admin/orgs/query
Headers:
x-vcloud-authorization: FQMWZgFq5mhMRSpt2ecxnsAXTxRpxdbZ/z2u6uwEH+w=
Body:
- Response
-
HTTP/1.1 200 OK
Headers:
Content-Length: 1585
Content-Type: application/vnd.vmware.vcloud.query.records+xml;version=5.5
Vary: Accept-Encoding
Body:
<?xml version="1.0" encoding="UTF-8"?><QueryResultRecords xmlns="http://www.vmware.com/vcloud/v1.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" href="https://vcloud.example.com/api/admin/orgs/query?page=1&pageSize=25&format=records" name="organization" page="1" pageSize="25" total="2" type="application/vnd.vmware.vcloud.query.records+xml" xsi:schemaLocation="http://www.vmware.com/vcloud/v1.5 http://https://vcloud.example.com/api/v1.5/schema/master.xsd">
<Link href="https://vcloud.example.com/api/admin/orgs/query?page=1&pageSize=25&format=references" rel="alternate" type="application/vnd.vmware.vcloud.query.references+xml"/>
<Link href="https://vcloud.example.com/api/admin/orgs/query?page=1&pageSize=25&format=idrecords" rel="alternate" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
<OrgRecord
canPublishCatalogs="false"
deployedVMQuota="100"
displayName="Default Organization"
href="https://vcloud.example.com/api/org/7b832bc5-3d65-45a2-8d35-da28388ab80a"
isEnabled="true"
isReadOnly="false"
name="Default"
numberOfCatalogs="1"
numberOfDisks="4"
numberOfGroups="1"
numberOfRunningVMs="0"
numberOfVApps="2"
numberOfVdcs="1"
storedVMQuota="1000"/>
<OrgRecord
canPublishCatalogs="true"
deployedVMQuota="10"
displayName="Organization Full Name"
href="https://vcloud.example.com/api/org/7cc8d565-1203-49bd-b50c-24e0acbaeb5a"
isEnabled="false"
isReadOnly="false"
name="OrgName"
numberOfCatalogs="0"
numberOfDisks="0"
numberOfGroups="0"
numberOfRunningVMs="0"
numberOfVApps="0"
numberOfVdcs="0"
storedVMQuota="15"/>
</QueryResultRecords>