CatalogWebService

Click here for a complete list of operations.

QueryResources

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /_tfs_resources/TeamFoundation/Administration/v3.0/CatalogService.asmx HTTP/1.1
Host: dev.pikacom.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://microsoft.com/webservices/QueryResources"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <QueryResources xmlns="http://microsoft.com/webservices/">
      <resourceIdentifiers>
        <guid>guid</guid>
        <guid>guid</guid>
      </resourceIdentifiers>
      <queryOptions>int</queryOptions>
    </QueryResources>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <QueryResourcesResponse xmlns="http://microsoft.com/webservices/">
      <QueryResourcesResult>
        <CatalogResourceTypes>
          <CatalogResourceType Identifier="guid" DisplayName="string">
            <Description>string</Description>
          </CatalogResourceType>
          <CatalogResourceType Identifier="guid" DisplayName="string">
            <Description>string</Description>
          </CatalogResourceType>
        </CatalogResourceTypes>
        <CatalogResources>
          <CatalogResource Identifier="guid" DisplayName="string" ResourceTypeIdentifier="guid" TempCorrelationId="guid" ctype="int" MatchedQuery="boolean">
            <Description>string</Description>
            <CatalogServiceReferences xsi:nil="true" />
            <Properties xsi:nil="true" />
            <NodeReferencePaths xsi:nil="true" />
          </CatalogResource>
          <CatalogResource Identifier="guid" DisplayName="string" ResourceTypeIdentifier="guid" TempCorrelationId="guid" ctype="int" MatchedQuery="boolean">
            <Description>string</Description>
            <CatalogServiceReferences xsi:nil="true" />
            <Properties xsi:nil="true" />
            <NodeReferencePaths xsi:nil="true" />
          </CatalogResource>
        </CatalogResources>
        <CatalogNodes>
          <CatalogNode FullPath="string" default="boolean" ResourceIdentifier="guid" ParentPath="string" ChildItem="string" NodeDependenciesIncluded="boolean" ctype="int" MatchedQuery="boolean">
            <NodeDependencies xsi:nil="true" />
          </CatalogNode>
          <CatalogNode FullPath="string" default="boolean" ResourceIdentifier="guid" ParentPath="string" ChildItem="string" NodeDependenciesIncluded="boolean" ctype="int" MatchedQuery="boolean">
            <NodeDependencies xsi:nil="true" />
          </CatalogNode>
        </CatalogNodes>
        <DeletedResources>
          <CatalogResource Identifier="guid" DisplayName="string" ResourceTypeIdentifier="guid" TempCorrelationId="guid" ctype="int" MatchedQuery="boolean">
            <Description>string</Description>
            <CatalogServiceReferences xsi:nil="true" />
            <Properties xsi:nil="true" />
            <NodeReferencePaths xsi:nil="true" />
          </CatalogResource>
          <CatalogResource Identifier="guid" DisplayName="string" ResourceTypeIdentifier="guid" TempCorrelationId="guid" ctype="int" MatchedQuery="boolean">
            <Description>string</Description>
            <CatalogServiceReferences xsi:nil="true" />
            <Properties xsi:nil="true" />
            <NodeReferencePaths xsi:nil="true" />
          </CatalogResource>
        </DeletedResources>
        <DeletedNodeResources>
          <CatalogResource Identifier="guid" DisplayName="string" ResourceTypeIdentifier="guid" TempCorrelationId="guid" ctype="int" MatchedQuery="boolean">
            <Description>string</Description>
            <CatalogServiceReferences xsi:nil="true" />
            <Properties xsi:nil="true" />
            <NodeReferencePaths xsi:nil="true" />
          </CatalogResource>
          <CatalogResource Identifier="guid" DisplayName="string" ResourceTypeIdentifier="guid" TempCorrelationId="guid" ctype="int" MatchedQuery="boolean">
            <Description>string</Description>
            <CatalogServiceReferences xsi:nil="true" />
            <Properties xsi:nil="true" />
            <NodeReferencePaths xsi:nil="true" />
          </CatalogResource>
        </DeletedNodeResources>
        <DeletedNodes>
          <CatalogNode FullPath="string" default="boolean" ResourceIdentifier="guid" ParentPath="string" ChildItem="string" NodeDependenciesIncluded="boolean" ctype="int" MatchedQuery="boolean">
            <NodeDependencies xsi:nil="true" />
          </CatalogNode>
          <CatalogNode FullPath="string" default="boolean" ResourceIdentifier="guid" ParentPath="string" ChildItem="string" NodeDependenciesIncluded="boolean" ctype="int" MatchedQuery="boolean">
            <NodeDependencies xsi:nil="true" />
          </CatalogNode>
        </DeletedNodes>
        <LocationServiceLastChangeId>int</LocationServiceLastChangeId>
      </QueryResourcesResult>
    </QueryResourcesResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /_tfs_resources/TeamFoundation/Administration/v3.0/CatalogService.asmx HTTP/1.1
Host: dev.pikacom.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <QueryResources xmlns="http://microsoft.com/webservices/">
      <resourceIdentifiers>
        <guid>guid</guid>
        <guid>guid</guid>
      </resourceIdentifiers>
      <queryOptions>int</queryOptions>
    </QueryResources>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <QueryResourcesResponse xmlns="http://microsoft.com/webservices/">
      <QueryResourcesResult>
        <CatalogResourceTypes>
          <CatalogResourceType Identifier="guid" DisplayName="string">
            <Description>string</Description>
          </CatalogResourceType>
          <CatalogResourceType Identifier="guid" DisplayName="string">
            <Description>string</Description>
          </CatalogResourceType>
        </CatalogResourceTypes>
        <CatalogResources>
          <CatalogResource Identifier="guid" DisplayName="string" ResourceTypeIdentifier="guid" TempCorrelationId="guid" ctype="int" MatchedQuery="boolean">
            <Description>string</Description>
            <CatalogServiceReferences xsi:nil="true" />
            <Properties xsi:nil="true" />
            <NodeReferencePaths xsi:nil="true" />
          </CatalogResource>
          <CatalogResource Identifier="guid" DisplayName="string" ResourceTypeIdentifier="guid" TempCorrelationId="guid" ctype="int" MatchedQuery="boolean">
            <Description>string</Description>
            <CatalogServiceReferences xsi:nil="true" />
            <Properties xsi:nil="true" />
            <NodeReferencePaths xsi:nil="true" />
          </CatalogResource>
        </CatalogResources>
        <CatalogNodes>
          <CatalogNode FullPath="string" default="boolean" ResourceIdentifier="guid" ParentPath="string" ChildItem="string" NodeDependenciesIncluded="boolean" ctype="int" MatchedQuery="boolean">
            <NodeDependencies xsi:nil="true" />
          </CatalogNode>
          <CatalogNode FullPath="string" default="boolean" ResourceIdentifier="guid" ParentPath="string" ChildItem="string" NodeDependenciesIncluded="boolean" ctype="int" MatchedQuery="boolean">
            <NodeDependencies xsi:nil="true" />
          </CatalogNode>
        </CatalogNodes>
        <DeletedResources>
          <CatalogResource Identifier="guid" DisplayName="string" ResourceTypeIdentifier="guid" TempCorrelationId="guid" ctype="int" MatchedQuery="boolean">
            <Description>string</Description>
            <CatalogServiceReferences xsi:nil="true" />
            <Properties xsi:nil="true" />
            <NodeReferencePaths xsi:nil="true" />
          </CatalogResource>
          <CatalogResource Identifier="guid" DisplayName="string" ResourceTypeIdentifier="guid" TempCorrelationId="guid" ctype="int" MatchedQuery="boolean">
            <Description>string</Description>
            <CatalogServiceReferences xsi:nil="true" />
            <Properties xsi:nil="true" />
            <NodeReferencePaths xsi:nil="true" />
          </CatalogResource>
        </DeletedResources>
        <DeletedNodeResources>
          <CatalogResource Identifier="guid" DisplayName="string" ResourceTypeIdentifier="guid" TempCorrelationId="guid" ctype="int" MatchedQuery="boolean">
            <Description>string</Description>
            <CatalogServiceReferences xsi:nil="true" />
            <Properties xsi:nil="true" />
            <NodeReferencePaths xsi:nil="true" />
          </CatalogResource>
          <CatalogResource Identifier="guid" DisplayName="string" ResourceTypeIdentifier="guid" TempCorrelationId="guid" ctype="int" MatchedQuery="boolean">
            <Description>string</Description>
            <CatalogServiceReferences xsi:nil="true" />
            <Properties xsi:nil="true" />
            <NodeReferencePaths xsi:nil="true" />
          </CatalogResource>
        </DeletedNodeResources>
        <DeletedNodes>
          <CatalogNode FullPath="string" default="boolean" ResourceIdentifier="guid" ParentPath="string" ChildItem="string" NodeDependenciesIncluded="boolean" ctype="int" MatchedQuery="boolean">
            <NodeDependencies xsi:nil="true" />
          </CatalogNode>
          <CatalogNode FullPath="string" default="boolean" ResourceIdentifier="guid" ParentPath="string" ChildItem="string" NodeDependenciesIncluded="boolean" ctype="int" MatchedQuery="boolean">
            <NodeDependencies xsi:nil="true" />
          </CatalogNode>
        </DeletedNodes>
        <LocationServiceLastChangeId>int</LocationServiceLastChangeId>
      </QueryResourcesResult>
    </QueryResourcesResponse>
  </soap12:Body>
</soap12:Envelope>