VaultService Web Service

VaultService

Click here for a complete list of operations.

BeginMergeBranchesHistoryQuery

Open a query on the server for labels

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

<?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>
    <BeginMergeBranchesHistoryQuery xmlns="http://www.sourcegear.com/schemas/vault">
      <mbhqr>
        <RepID>int</RepID>
        <OriginItemPath>string</OriginItemPath>
        <DestinationItemPath>string</DestinationItemPath>
        <RetrievalOption>AllHistory or IncludePastDays or LastUserMergeMarker or Undefined</RetrievalOption>
        <IncludePastDays>int</IncludePastDays>
        <IncludeLabels>boolean</IncludeLabels>
      </mbhqr>
      <nRowLimit>long</nRowLimit>
    </BeginMergeBranchesHistoryQuery>
  </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>
    <BeginMergeBranchesHistoryQueryResponse xmlns="http://www.sourcegear.com/schemas/vault">
      <BeginMergeBranchesHistoryQueryResult>int</BeginMergeBranchesHistoryQueryResult>
      <nVersionRowsRetrieved>long</nVersionRowsRetrieved>
      <strVersionQryToken>string</strVersionQryToken>
      <nGenesisVersion>long</nGenesisVersion>
      <nLabelsRowsRetrieved>long</nLabelsRowsRetrieved>
      <strLabelQryToken>string</strLabelQryToken>
      <arMergeMarkers>
        <MergeMarker>
          <MarkerID xmlns="http://www.sourcegear.com/schemas/vaultplugin/">int</MarkerID>
          <RepID xmlns="http://www.sourcegear.com/schemas/vaultplugin/">int</RepID>
          <OrigObjID xmlns="http://www.sourcegear.com/schemas/vaultplugin/">long</OrigObjID>
          <DestObjID xmlns="http://www.sourcegear.com/schemas/vaultplugin/">long</DestObjID>
          <MarkerRanges xmlns="http://www.sourcegear.com/schemas/vaultplugin/">
            <ArrayOfLong xsi:nil="true" />
            <ArrayOfLong xsi:nil="true" />
          </MarkerRanges>
          <OrigItemPath xmlns="http://www.sourcegear.com/schemas/vaultplugin/">string</OrigItemPath>
          <DestItemPath xmlns="http://www.sourcegear.com/schemas/vaultplugin/">string</DestItemPath>
          <UserID xmlns="http://www.sourcegear.com/schemas/vaultplugin/">int</UserID>
          <UserLogin xmlns="http://www.sourcegear.com/schemas/vaultplugin/">string</UserLogin>
          <DateCreated xmlns="http://www.sourcegear.com/schemas/vaultplugin/">
            <Ticks>long</Ticks>
          </DateCreated>
        </MergeMarker>
        <MergeMarker>
          <MarkerID xmlns="http://www.sourcegear.com/schemas/vaultplugin/">int</MarkerID>
          <RepID xmlns="http://www.sourcegear.com/schemas/vaultplugin/">int</RepID>
          <OrigObjID xmlns="http://www.sourcegear.com/schemas/vaultplugin/">long</OrigObjID>
          <DestObjID xmlns="http://www.sourcegear.com/schemas/vaultplugin/">long</DestObjID>
          <MarkerRanges xmlns="http://www.sourcegear.com/schemas/vaultplugin/">
            <ArrayOfLong xsi:nil="true" />
            <ArrayOfLong xsi:nil="true" />
          </MarkerRanges>
          <OrigItemPath xmlns="http://www.sourcegear.com/schemas/vaultplugin/">string</OrigItemPath>
          <DestItemPath xmlns="http://www.sourcegear.com/schemas/vaultplugin/">string</DestItemPath>
          <UserID xmlns="http://www.sourcegear.com/schemas/vaultplugin/">int</UserID>
          <UserLogin xmlns="http://www.sourcegear.com/schemas/vaultplugin/">string</UserLogin>
          <DateCreated xmlns="http://www.sourcegear.com/schemas/vaultplugin/">
            <Ticks>long</Ticks>
          </DateCreated>
        </MergeMarker>
      </arMergeMarkers>
    </BeginMergeBranchesHistoryQueryResponse>
  </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>
    <BeginMergeBranchesHistoryQuery xmlns="http://www.sourcegear.com/schemas/vault">
      <mbhqr>
        <RepID>int</RepID>
        <OriginItemPath>string</OriginItemPath>
        <DestinationItemPath>string</DestinationItemPath>
        <RetrievalOption>AllHistory or IncludePastDays or LastUserMergeMarker or Undefined</RetrievalOption>
        <IncludePastDays>int</IncludePastDays>
        <IncludeLabels>boolean</IncludeLabels>
      </mbhqr>
      <nRowLimit>long</nRowLimit>
    </BeginMergeBranchesHistoryQuery>
  </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>
    <BeginMergeBranchesHistoryQueryResponse xmlns="http://www.sourcegear.com/schemas/vault">
      <BeginMergeBranchesHistoryQueryResult>int</BeginMergeBranchesHistoryQueryResult>
      <nVersionRowsRetrieved>long</nVersionRowsRetrieved>
      <strVersionQryToken>string</strVersionQryToken>
      <nGenesisVersion>long</nGenesisVersion>
      <nLabelsRowsRetrieved>long</nLabelsRowsRetrieved>
      <strLabelQryToken>string</strLabelQryToken>
      <arMergeMarkers>
        <MergeMarker>
          <MarkerID xmlns="http://www.sourcegear.com/schemas/vaultplugin/">int</MarkerID>
          <RepID xmlns="http://www.sourcegear.com/schemas/vaultplugin/">int</RepID>
          <OrigObjID xmlns="http://www.sourcegear.com/schemas/vaultplugin/">long</OrigObjID>
          <DestObjID xmlns="http://www.sourcegear.com/schemas/vaultplugin/">long</DestObjID>
          <MarkerRanges xmlns="http://www.sourcegear.com/schemas/vaultplugin/">
            <ArrayOfLong xsi:nil="true" />
            <ArrayOfLong xsi:nil="true" />
          </MarkerRanges>
          <OrigItemPath xmlns="http://www.sourcegear.com/schemas/vaultplugin/">string</OrigItemPath>
          <DestItemPath xmlns="http://www.sourcegear.com/schemas/vaultplugin/">string</DestItemPath>
          <UserID xmlns="http://www.sourcegear.com/schemas/vaultplugin/">int</UserID>
          <UserLogin xmlns="http://www.sourcegear.com/schemas/vaultplugin/">string</UserLogin>
          <DateCreated xmlns="http://www.sourcegear.com/schemas/vaultplugin/">
            <Ticks>long</Ticks>
          </DateCreated>
        </MergeMarker>
        <MergeMarker>
          <MarkerID xmlns="http://www.sourcegear.com/schemas/vaultplugin/">int</MarkerID>
          <RepID xmlns="http://www.sourcegear.com/schemas/vaultplugin/">int</RepID>
          <OrigObjID xmlns="http://www.sourcegear.com/schemas/vaultplugin/">long</OrigObjID>
          <DestObjID xmlns="http://www.sourcegear.com/schemas/vaultplugin/">long</DestObjID>
          <MarkerRanges xmlns="http://www.sourcegear.com/schemas/vaultplugin/">
            <ArrayOfLong xsi:nil="true" />
            <ArrayOfLong xsi:nil="true" />
          </MarkerRanges>
          <OrigItemPath xmlns="http://www.sourcegear.com/schemas/vaultplugin/">string</OrigItemPath>
          <DestItemPath xmlns="http://www.sourcegear.com/schemas/vaultplugin/">string</DestItemPath>
          <UserID xmlns="http://www.sourcegear.com/schemas/vaultplugin/">int</UserID>
          <UserLogin xmlns="http://www.sourcegear.com/schemas/vaultplugin/">string</UserLogin>
          <DateCreated xmlns="http://www.sourcegear.com/schemas/vaultplugin/">
            <Ticks>long</Ticks>
          </DateCreated>
        </MergeMarker>
      </arMergeMarkers>
    </BeginMergeBranchesHistoryQueryResponse>
  </soap12:Body>
</soap12:Envelope>