VaultService Web Service

VaultService

Click here for a complete list of operations.

FindInFilesByFolder

Run a search for a string of characters within the provided files.

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 /vaultservice/vaultservice.asmx HTTP/1.1
Host: vaultdemo.sourcegear.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.sourcegear.com/schemas/vault/FindInFilesByFolder"

<?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:Header>
    <VaultAuth xmlns="http://www.sourcegear.com/schemas/vault">
      <VaultSessionID>string</VaultSessionID>
      <Token>string</Token>
    </VaultAuth>
  </soap:Header>
  <soap:Body>
    <FindInFilesByFolder xmlns="http://www.sourcegear.com/schemas/vault">
      <q>
        <FolderPath>string</FolderPath>
        <Recursive>boolean</Recursive>
        <IncludeFiles>
          <string>string</string>
          <string>string</string>
        </IncludeFiles>
        <ExcludeFiles>
          <string>string</string>
          <string>string</string>
        </ExcludeFiles>
      </q>
      <bUseExceptions>boolean</bUseExceptions>
    </FindInFilesByFolder>
  </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>
    <FindInFilesByFolderResponse xmlns="http://www.sourcegear.com/schemas/vault">
      <FindInFilesByFolderResult>int</FindInFilesByFolderResult>
      <arFifData>
        <FindInFilesData>
          <FileName>string</FileName>
          <FolderPaths>
            <string>string</string>
            <string>string</string>
          </FolderPaths>
          <FindInFileLines>
            <FindInFilesLineData xsi:nil="true" />
            <FindInFilesLineData xsi:nil="true" />
          </FindInFileLines>
        </FindInFilesData>
        <FindInFilesData>
          <FileName>string</FileName>
          <FolderPaths>
            <string>string</string>
            <string>string</string>
          </FolderPaths>
          <FindInFileLines>
            <FindInFilesLineData xsi:nil="true" />
            <FindInFilesLineData xsi:nil="true" />
          </FindInFileLines>
        </FindInFilesData>
      </arFifData>
    </FindInFilesByFolderResponse>
  </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 /vaultservice/vaultservice.asmx HTTP/1.1
Host: vaultdemo.sourcegear.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:Header>
    <VaultAuth xmlns="http://www.sourcegear.com/schemas/vault">
      <VaultSessionID>string</VaultSessionID>
      <Token>string</Token>
    </VaultAuth>
  </soap12:Header>
  <soap12:Body>
    <FindInFilesByFolder xmlns="http://www.sourcegear.com/schemas/vault">
      <q>
        <FolderPath>string</FolderPath>
        <Recursive>boolean</Recursive>
        <IncludeFiles>
          <string>string</string>
          <string>string</string>
        </IncludeFiles>
        <ExcludeFiles>
          <string>string</string>
          <string>string</string>
        </ExcludeFiles>
      </q>
      <bUseExceptions>boolean</bUseExceptions>
    </FindInFilesByFolder>
  </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>
    <FindInFilesByFolderResponse xmlns="http://www.sourcegear.com/schemas/vault">
      <FindInFilesByFolderResult>int</FindInFilesByFolderResult>
      <arFifData>
        <FindInFilesData>
          <FileName>string</FileName>
          <FolderPaths>
            <string>string</string>
            <string>string</string>
          </FolderPaths>
          <FindInFileLines>
            <FindInFilesLineData xsi:nil="true" />
            <FindInFilesLineData xsi:nil="true" />
          </FindInFileLines>
        </FindInFilesData>
        <FindInFilesData>
          <FileName>string</FileName>
          <FolderPaths>
            <string>string</string>
            <string>string</string>
          </FolderPaths>
          <FindInFileLines>
            <FindInFilesLineData xsi:nil="true" />
            <FindInFilesLineData xsi:nil="true" />
          </FindInFileLines>
        </FindInFilesData>
      </arFifData>
    </FindInFilesByFolderResponse>
  </soap12:Body>
</soap12:Envelope>