VMware Cloud Director API - GET-ExecuteQuery

VMware Cloud Director API - GET-ExecuteQuery

GET /query

Operation:
GET /query
Description:
REST API General queries handler
Since:
1.5
Federated:
Yes
Input parameters
Consume media type(s):
None
Input type:
None
Query parameters
Parameter
type
Documentation
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 result of the query executed with provided filter in xml format.

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
application/vnd.vmware.vcloud.query.queryList+xml
application/vnd.vmware.vcloud.query.queryList+json
Output type:
T extends com.vmware.vcloud.api.rest.schema_v1_5.ContainerType
Examples
Get query list.

Request
HTTP 1.1
GET /api/query

Headers:
x-vcloud-authorization: M69zc2o7Ol7AuYVBAslGYbnTluZZVZKIYa1HPe8MzEk=

Body:
Response
HTTP/1.1 200 OK

Headers:
Content-Length: 30280
Content-Type: application/vnd.vmware.vcloud.query.querylist+xml;version=5.5
Vary: Accept-Encoding

Body:
<?xml version="1.0" encoding="UTF-8"?><QueryList
    xmlns="http://www.vmware.com/vcloud/v1.5"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    href="https://vcloud.example.com/api/query"
    type="application/vnd.vmware.vcloud.query.queryList+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/query?type=organization&amp;format=references" name="organization" rel="down" type="application/vnd.vmware.vcloud.query.references+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=organization&amp;format=records" name="organization" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=organization&amp;format=idrecords" name="organization" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=adminOrgNetwork&amp;format=references" name="adminOrgNetwork" rel="down" type="application/vnd.vmware.vcloud.query.references+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=adminOrgNetwork&amp;format=records" name="adminOrgNetwork" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=adminOrgNetwork&amp;format=idrecords" name="adminOrgNetwork" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=adminOrgVdc&amp;format=references" name="adminOrgVdc" rel="down" type="application/vnd.vmware.vcloud.query.references+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=adminOrgVdc&amp;format=records" name="adminOrgVdc" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=adminOrgVdc&amp;format=idrecords" name="adminOrgVdc" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=providerVdc&amp;format=references" name="providerVdc" rel="down" type="application/vnd.vmware.vcloud.query.references+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=providerVdc&amp;format=records" name="providerVdc" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=providerVdc&amp;format=idrecords" name="providerVdc" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=externalNetwork&amp;format=references" name="externalNetwork" rel="down" type="application/vnd.vmware.vcloud.query.references+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=externalNetwork&amp;format=records" name="externalNetwork" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=externalNetwork&amp;format=idrecords" name="externalNetwork" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=strandedUser&amp;format=references" name="strandedUser" rel="down" type="application/vnd.vmware.vcloud.query.references+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=strandedUser&amp;format=records" name="strandedUser" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=strandedUser&amp;format=idrecords" name="strandedUser" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=role&amp;format=references" name="role" rel="down" type="application/vnd.vmware.vcloud.query.references+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=role&amp;format=records" name="role" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=role&amp;format=idrecords" name="role" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=event&amp;format=records" name="event" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=event&amp;format=idrecords" name="event" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=resourcePool&amp;format=records" name="resourcePool" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=resourcePool&amp;format=idrecords" name="resourcePool" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=datastore&amp;format=references" name="datastore" rel="down" type="application/vnd.vmware.vcloud.query.references+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=datastore&amp;format=records" name="datastore" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=datastore&amp;format=idrecords" name="datastore" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=networkPool&amp;format=references" name="networkPool" rel="down" type="application/vnd.vmware.vcloud.query.references+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=networkPool&amp;format=records" name="networkPool" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=networkPool&amp;format=idrecords" name="networkPool" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=portgroup&amp;format=records" name="portgroup" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=portgroup&amp;format=idrecords" name="portgroup" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=dvSwitch&amp;format=records" name="dvSwitch" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=dvSwitch&amp;format=idrecords" name="dvSwitch" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=cell&amp;format=records" name="cell" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=cell&amp;format=idrecords" name="cell" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=virtualCenter&amp;format=references" name="virtualCenter" rel="down" type="application/vnd.vmware.vcloud.query.references+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=virtualCenter&amp;format=records" name="virtualCenter" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=virtualCenter&amp;format=idrecords" name="virtualCenter" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=host&amp;format=references" name="host" rel="down" type="application/vnd.vmware.vcloud.query.references+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=host&amp;format=records" name="host" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=host&amp;format=idrecords" name="host" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=adminVApp&amp;format=references" name="adminVApp" rel="down" type="application/vnd.vmware.vcloud.query.references+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=adminVApp&amp;format=records" name="adminVApp" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=adminVApp&amp;format=idrecords" name="adminVApp" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=right&amp;format=references" name="right" rel="down" type="application/vnd.vmware.vcloud.query.references+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=right&amp;format=records" name="right" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=right&amp;format=idrecords" name="right" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=adminVM&amp;format=references" name="adminVM" rel="down" type="application/vnd.vmware.vcloud.query.references+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=adminVM&amp;format=records" name="adminVM" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=adminVM&amp;format=idrecords" name="adminVM" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=adminAllocatedExternalAddress&amp;format=records" name="adminAllocatedExternalAddress" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=adminAllocatedExternalAddress&amp;format=idrecords" name="adminAllocatedExternalAddress" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=vAppOrgNetworkRelation&amp;format=references" name="vAppOrgNetworkRelation" rel="down" type="application/vnd.vmware.vcloud.query.references+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=vAppOrgNetworkRelation&amp;format=records" name="vAppOrgNetworkRelation" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=vAppOrgNetworkRelation&amp;format=idrecords" name="vAppOrgNetworkRelation" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=orgVdcResourcePoolRelation&amp;format=records" name="orgVdcResourcePoolRelation" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=orgVdcResourcePoolRelation&amp;format=idrecords" name="orgVdcResourcePoolRelation" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=providerVdcResourcePoolRelation&amp;format=records" name="providerVdcResourcePoolRelation" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=providerVdcResourcePoolRelation&amp;format=idrecords" name="providerVdcResourcePoolRelation" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=datastoreProviderVdcRelation&amp;format=records" name="datastoreProviderVdcRelation" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=datastoreProviderVdcRelation&amp;format=idrecords" name="datastoreProviderVdcRelation" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=adminUser&amp;format=references" name="adminUser" rel="down" type="application/vnd.vmware.vcloud.query.references+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=adminUser&amp;format=records" name="adminUser" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=adminUser&amp;format=idrecords" name="adminUser" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=adminGroup&amp;format=references" name="adminGroup" rel="down" type="application/vnd.vmware.vcloud.query.references+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=adminGroup&amp;format=records" name="adminGroup" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=adminGroup&amp;format=idrecords" name="adminGroup" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=adminVAppNetwork&amp;format=references" name="adminVAppNetwork" rel="down" type="application/vnd.vmware.vcloud.query.references+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=adminVAppNetwork&amp;format=records" name="adminVAppNetwork" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=adminVAppNetwork&amp;format=idrecords" name="adminVAppNetwork" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=adminCatalog&amp;format=references" name="adminCatalog" rel="down" type="application/vnd.vmware.vcloud.query.references+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=adminCatalog&amp;format=records" name="adminCatalog" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=adminCatalog&amp;format=idrecords" name="adminCatalog" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
    <Link href="https://vcloud.example.com/api/query?type=adminCatalogItem&amp;format=references"