VaultService Web Service

VaultService

Click here for a complete list of operations.

GetRepositoryStructure

Get a delta describing the entire repository structure.

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: scc.teamwise.de
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.sourcegear.com/schemas/vault/GetRepositoryStructure"

<?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>
    <GetRepositoryStructure xmlns="http://www.sourcegear.com/schemas/vault">
      <nRepID>int</nRepID>
      <nBaseRevision>long</nBaseRevision>
      <nTargetRevision>long</nTargetRevision>
      <dtLastClientSecurityCheck>
        <Ticks>long</Ticks>
      </dtLastClientSecurityCheck>
      <dtLatestServerSecurityCheck>
        <Ticks>long</Ticks>
      </dtLatestServerSecurityCheck>
      <nReturnTargetRevision>long</nReturnTargetRevision>
      <rd>
        <BaseRevision>long</BaseRevision>
        <TargetRevision>long</TargetRevision>
        <BaseName>string</BaseName>
        <TargetName>string</TargetName>
        <Root>
          <Folders>
            <VaultFolderDelta xsi:nil="true" />
            <VaultFolderDelta xsi:nil="true" />
          </Folders>
          <Files>
            <VaultFileDelta xsi:nil="true" />
            <VaultFileDelta xsi:nil="true" />
          </Files>
        </Root>
        <Shares>
          <long>long</long>
          <long>long</long>
        </Shares>
      </rd>
      <bUseDBDeltaOnCacheMiss>boolean</bUseDBDeltaOnCacheMiss>
    </GetRepositoryStructure>
  </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>
    <GetRepositoryStructureResponse xmlns="http://www.sourcegear.com/schemas/vault">
      <GetRepositoryStructureResult>int</GetRepositoryStructureResult>
      <dtLatestServerSecurityCheck>
        <Ticks>long</Ticks>
      </dtLatestServerSecurityCheck>
      <nReturnTargetRevision>long</nReturnTargetRevision>
      <rd>
        <BaseRevision>long</BaseRevision>
        <TargetRevision>long</TargetRevision>
        <BaseName>string</BaseName>
        <TargetName>string</TargetName>
        <Root>
          <Folders>
            <VaultFolderDelta xsi:nil="true" />
            <VaultFolderDelta xsi:nil="true" />
          </Folders>
          <Files>
            <VaultFileDelta xsi:nil="true" />
            <VaultFileDelta xsi:nil="true" />
          </Files>
        </Root>
        <Shares>
          <long>long</long>
          <long>long</long>
        </Shares>
      </rd>
    </GetRepositoryStructureResponse>
  </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: scc.teamwise.de
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>
    <GetRepositoryStructure xmlns="http://www.sourcegear.com/schemas/vault">
      <nRepID>int</nRepID>
      <nBaseRevision>long</nBaseRevision>
      <nTargetRevision>long</nTargetRevision>
      <dtLastClientSecurityCheck>
        <Ticks>long</Ticks>
      </dtLastClientSecurityCheck>
      <dtLatestServerSecurityCheck>
        <Ticks>long</Ticks>
      </dtLatestServerSecurityCheck>
      <nReturnTargetRevision>long</nReturnTargetRevision>
      <rd>
        <BaseRevision>long</BaseRevision>
        <TargetRevision>long</TargetRevision>
        <BaseName>string</BaseName>
        <TargetName>string</TargetName>
        <Root>
          <Folders>
            <VaultFolderDelta xsi:nil="true" />
            <VaultFolderDelta xsi:nil="true" />
          </Folders>
          <Files>
            <VaultFileDelta xsi:nil="true" />
            <VaultFileDelta xsi:nil="true" />
          </Files>
        </Root>
        <Shares>
          <long>long</long>
          <long>long</long>
        </Shares>
      </rd>
      <bUseDBDeltaOnCacheMiss>boolean</bUseDBDeltaOnCacheMiss>
    </GetRepositoryStructure>
  </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>
    <GetRepositoryStructureResponse xmlns="http://www.sourcegear.com/schemas/vault">
      <GetRepositoryStructureResult>int</GetRepositoryStructureResult>
      <dtLatestServerSecurityCheck>
        <Ticks>long</Ticks>
      </dtLatestServerSecurityCheck>
      <nReturnTargetRevision>long</nReturnTargetRevision>
      <rd>
        <BaseRevision>long</BaseRevision>
        <TargetRevision>long</TargetRevision>
        <BaseName>string</BaseName>
        <TargetName>string</TargetName>
        <Root>
          <Folders>
            <VaultFolderDelta xsi:nil="true" />
            <VaultFolderDelta xsi:nil="true" />
          </Folders>
          <Files>
            <VaultFileDelta xsi:nil="true" />
            <VaultFileDelta xsi:nil="true" />
          </Files>
        </Root>
        <Shares>
          <long>long</long>
          <long>long</long>
        </Shares>
      </rd>
    </GetRepositoryStructureResponse>
  </soap12:Body>
</soap12:Envelope>