VaultService Web Service

VaultService

Click here for a complete list of operations.

GetRepositories

Return a complete list of available source code repositories.

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/GetRepositories"

<?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>
    <GetRepositories xmlns="http://www.sourcegear.com/schemas/vault">
      <reps>
        <VaultRepositoryInfo>
          <RepID>int</RepID>
          <UniqueRepID>string</UniqueRepID>
          <RepName>string</RepName>
          <RevID>long</RevID>
          <FolderCount>int</FolderCount>
          <FileCount>int</FileCount>
          <TreeSize>long</TreeSize>
          <DbSize>long</DbSize>
          <DeletedFileCount>int</DeletedFileCount>
          <DeletedFolderCount>int</DeletedFolderCount>
          <FolderSecurityEnabled>boolean</FolderSecurityEnabled>
          <RequireCheckInComments>boolean</RequireCheckInComments>
          <RequireExclusiveLocks>boolean</RequireExclusiveLocks>
          <Status>int</Status>
          <RootVersion>long</RootVersion>
          <DefaultRepositoryAccess>None or Access or FullAdmin</DefaultRepositoryAccess>
          <RequireBugID>boolean</RequireBugID>
          <EnableKeyword>boolean</EnableKeyword>
        </VaultRepositoryInfo>
        <VaultRepositoryInfo>
          <RepID>int</RepID>
          <UniqueRepID>string</UniqueRepID>
          <RepName>string</RepName>
          <RevID>long</RevID>
          <FolderCount>int</FolderCount>
          <FileCount>int</FileCount>
          <TreeSize>long</TreeSize>
          <DbSize>long</DbSize>
          <DeletedFileCount>int</DeletedFileCount>
          <DeletedFolderCount>int</DeletedFolderCount>
          <FolderSecurityEnabled>boolean</FolderSecurityEnabled>
          <RequireCheckInComments>boolean</RequireCheckInComments>
          <RequireExclusiveLocks>boolean</RequireExclusiveLocks>
          <Status>int</Status>
          <RootVersion>long</RootVersion>
          <DefaultRepositoryAccess>None or Access or FullAdmin</DefaultRepositoryAccess>
          <RequireBugID>boolean</RequireBugID>
          <EnableKeyword>boolean</EnableKeyword>
        </VaultRepositoryInfo>
      </reps>
    </GetRepositories>
  </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>
    <GetRepositoriesResponse xmlns="http://www.sourcegear.com/schemas/vault">
      <GetRepositoriesResult>int</GetRepositoriesResult>
      <reps>
        <VaultRepositoryInfo>
          <RepID>int</RepID>
          <UniqueRepID>string</UniqueRepID>
          <RepName>string</RepName>
          <RevID>long</RevID>
          <FolderCount>int</FolderCount>
          <FileCount>int</FileCount>
          <TreeSize>long</TreeSize>
          <DbSize>long</DbSize>
          <DeletedFileCount>int</DeletedFileCount>
          <DeletedFolderCount>int</DeletedFolderCount>
          <FolderSecurityEnabled>boolean</FolderSecurityEnabled>
          <RequireCheckInComments>boolean</RequireCheckInComments>
          <RequireExclusiveLocks>boolean</RequireExclusiveLocks>
          <Status>int</Status>
          <RootVersion>long</RootVersion>
          <DefaultRepositoryAccess>None or Access or FullAdmin</DefaultRepositoryAccess>
          <RequireBugID>boolean</RequireBugID>
          <EnableKeyword>boolean</EnableKeyword>
        </VaultRepositoryInfo>
        <VaultRepositoryInfo>
          <RepID>int</RepID>
          <UniqueRepID>string</UniqueRepID>
          <RepName>string</RepName>
          <RevID>long</RevID>
          <FolderCount>int</FolderCount>
          <FileCount>int</FileCount>
          <TreeSize>long</TreeSize>
          <DbSize>long</DbSize>
          <DeletedFileCount>int</DeletedFileCount>
          <DeletedFolderCount>int</DeletedFolderCount>
          <FolderSecurityEnabled>boolean</FolderSecurityEnabled>
          <RequireCheckInComments>boolean</RequireCheckInComments>
          <RequireExclusiveLocks>boolean</RequireExclusiveLocks>
          <Status>int</Status>
          <RootVersion>long</RootVersion>
          <DefaultRepositoryAccess>None or Access or FullAdmin</DefaultRepositoryAccess>
          <RequireBugID>boolean</RequireBugID>
          <EnableKeyword>boolean</EnableKeyword>
        </VaultRepositoryInfo>
      </reps>
    </GetRepositoriesResponse>
  </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>
    <GetRepositories xmlns="http://www.sourcegear.com/schemas/vault">
      <reps>
        <VaultRepositoryInfo>
          <RepID>int</RepID>
          <UniqueRepID>string</UniqueRepID>
          <RepName>string</RepName>
          <RevID>long</RevID>
          <FolderCount>int</FolderCount>
          <FileCount>int</FileCount>
          <TreeSize>long</TreeSize>
          <DbSize>long</DbSize>
          <DeletedFileCount>int</DeletedFileCount>
          <DeletedFolderCount>int</DeletedFolderCount>
          <FolderSecurityEnabled>boolean</FolderSecurityEnabled>
          <RequireCheckInComments>boolean</RequireCheckInComments>
          <RequireExclusiveLocks>boolean</RequireExclusiveLocks>
          <Status>int</Status>
          <RootVersion>long</RootVersion>
          <DefaultRepositoryAccess>None or Access or FullAdmin</DefaultRepositoryAccess>
          <RequireBugID>boolean</RequireBugID>
          <EnableKeyword>boolean</EnableKeyword>
        </VaultRepositoryInfo>
        <VaultRepositoryInfo>
          <RepID>int</RepID>
          <UniqueRepID>string</UniqueRepID>
          <RepName>string</RepName>
          <RevID>long</RevID>
          <FolderCount>int</FolderCount>
          <FileCount>int</FileCount>
          <TreeSize>long</TreeSize>
          <DbSize>long</DbSize>
          <DeletedFileCount>int</DeletedFileCount>
          <DeletedFolderCount>int</DeletedFolderCount>
          <FolderSecurityEnabled>boolean</FolderSecurityEnabled>
          <RequireCheckInComments>boolean</RequireCheckInComments>
          <RequireExclusiveLocks>boolean</RequireExclusiveLocks>
          <Status>int</Status>
          <RootVersion>long</RootVersion>
          <DefaultRepositoryAccess>None or Access or FullAdmin</DefaultRepositoryAccess>
          <RequireBugID>boolean</RequireBugID>
          <EnableKeyword>boolean</EnableKeyword>
        </VaultRepositoryInfo>
      </reps>
    </GetRepositories>
  </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>
    <GetRepositoriesResponse xmlns="http://www.sourcegear.com/schemas/vault">
      <GetRepositoriesResult>int</GetRepositoriesResult>
      <reps>
        <VaultRepositoryInfo>
          <RepID>int</RepID>
          <UniqueRepID>string</UniqueRepID>
          <RepName>string</RepName>
          <RevID>long</RevID>
          <FolderCount>int</FolderCount>
          <FileCount>int</FileCount>
          <TreeSize>long</TreeSize>
          <DbSize>long</DbSize>
          <DeletedFileCount>int</DeletedFileCount>
          <DeletedFolderCount>int</DeletedFolderCount>
          <FolderSecurityEnabled>boolean</FolderSecurityEnabled>
          <RequireCheckInComments>boolean</RequireCheckInComments>
          <RequireExclusiveLocks>boolean</RequireExclusiveLocks>
          <Status>int</Status>
          <RootVersion>long</RootVersion>
          <DefaultRepositoryAccess>None or Access or FullAdmin</DefaultRepositoryAccess>
          <RequireBugID>boolean</RequireBugID>
          <EnableKeyword>boolean</EnableKeyword>
        </VaultRepositoryInfo>
        <VaultRepositoryInfo>
          <RepID>int</RepID>
          <UniqueRepID>string</UniqueRepID>
          <RepName>string</RepName>
          <RevID>long</RevID>
          <FolderCount>int</FolderCount>
          <FileCount>int</FileCount>
          <TreeSize>long</TreeSize>
          <DbSize>long</DbSize>
          <DeletedFileCount>int</DeletedFileCount>
          <DeletedFolderCount>int</DeletedFolderCount>
          <FolderSecurityEnabled>boolean</FolderSecurityEnabled>
          <RequireCheckInComments>boolean</RequireCheckInComments>
          <RequireExclusiveLocks>boolean</RequireExclusiveLocks>
          <Status>int</Status>
          <RootVersion>long</RootVersion>
          <DefaultRepositoryAccess>None or Access or FullAdmin</DefaultRepositoryAccess>
          <RequireBugID>boolean</RequireBugID>
          <EnableKeyword>boolean</EnableKeyword>
        </VaultRepositoryInfo>
      </reps>
    </GetRepositoriesResponse>
  </soap12:Body>
</soap12:Envelope>