VaultService Web Service

VaultService

Click here for a complete list of operations.

BeginHistoryQuery

Open a query on the server

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

<?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>
    <BeginHistoryQuery xmlns="http://www.sourcegear.com/schemas/vault">
      <reqHQ>
        <IsFolder>boolean</IsFolder>
        <RepID>int</RepID>
        <TopID>long</TopID>
        <TopName>string</TopName>
        <Recursive>boolean</Recursive>
        <DateFilterType>int</DateFilterType>
        <LabelFilterType>int</LabelFilterType>
        <DateFilterMask>unsignedInt</DateFilterMask>
        <IncludePastDays>int</IncludePastDays>
        <BeginDate>
          <Ticks>long</Ticks>
        </BeginDate>
        <LabelBeginDate>
          <Ticks>long</Ticks>
        </LabelBeginDate>
        <EndDate>
          <Ticks>long</Ticks>
        </EndDate>
        <LabelEndDate>
          <Ticks>long</Ticks>
        </LabelEndDate>
        <LabelBeginName>string</LabelBeginName>
        <LabelEndName>string</LabelEndName>
        <SubstringType>int</SubstringType>
        <Substrings>
          <string>string</string>
          <string>string</string>
        </Substrings>
        <Users>
          <VaultUser>
            <AuthType>Vault or ActiveDirectory or Mantis or SourceOffSite</AuthType>
            <AuthDomain>string</AuthDomain>
            <AccessInfo xsi:nil="true" />
            <UserType>RegularUser or WebOnlyUser</UserType>
            <UserID>int</UserID>
            <Login>string</Login>
            <Name>string</Name>
            <Password>string</Password>
            <Email>string</Email>
            <Description>string</Description>
            <isActive>boolean</isActive>
            <Status>int</Status>
            <DefaultRights>unsignedInt</DefaultRights>
            <FolderRights xsi:nil="true" />
            <BelongToGroups xsi:nil="true" />
          </VaultUser>
          <VaultUser>
            <AuthType>Vault or ActiveDirectory or Mantis or SourceOffSite</AuthType>
            <AuthDomain>string</AuthDomain>
            <AccessInfo xsi:nil="true" />
            <UserType>RegularUser or WebOnlyUser</UserType>
            <UserID>int</UserID>
            <Login>string</Login>
            <Name>string</Name>
            <Password>string</Password>
            <Email>string</Email>
            <Description>string</Description>
            <isActive>boolean</isActive>
            <Status>int</Status>
            <DefaultRights>unsignedInt</DefaultRights>
            <FolderRights xsi:nil="true" />
            <BelongToGroups xsi:nil="true" />
          </VaultUser>
        </Users>
        <Actions>
          <long>long</long>
          <long>long</long>
        </Actions>
        <CommentFilter>int</CommentFilter>
        <CommentSubstring>string</CommentSubstring>
        <Sorts>
          <long>long</long>
          <long>long</long>
        </Sorts>
      </reqHQ>
      <nRowLimit>int</nRowLimit>
      <nRowsRetrieved>int</nRowsRetrieved>
      <strQryToken>string</strQryToken>
    </BeginHistoryQuery>
  </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>
    <BeginHistoryQueryResponse xmlns="http://www.sourcegear.com/schemas/vault">
      <BeginHistoryQueryResult>int</BeginHistoryQueryResult>
      <nRowsRetrieved>int</nRowsRetrieved>
      <strQryToken>string</strQryToken>
    </BeginHistoryQueryResponse>
  </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>
    <BeginHistoryQuery xmlns="http://www.sourcegear.com/schemas/vault">
      <reqHQ>
        <IsFolder>boolean</IsFolder>
        <RepID>int</RepID>
        <TopID>long</TopID>
        <TopName>string</TopName>
        <Recursive>boolean</Recursive>
        <DateFilterType>int</DateFilterType>
        <LabelFilterType>int</LabelFilterType>
        <DateFilterMask>unsignedInt</DateFilterMask>
        <IncludePastDays>int</IncludePastDays>
        <BeginDate>
          <Ticks>long</Ticks>
        </BeginDate>
        <LabelBeginDate>
          <Ticks>long</Ticks>
        </LabelBeginDate>
        <EndDate>
          <Ticks>long</Ticks>
        </EndDate>
        <LabelEndDate>
          <Ticks>long</Ticks>
        </LabelEndDate>
        <LabelBeginName>string</LabelBeginName>
        <LabelEndName>string</LabelEndName>
        <SubstringType>int</SubstringType>
        <Substrings>
          <string>string</string>
          <string>string</string>
        </Substrings>
        <Users>
          <VaultUser>
            <AuthType>Vault or ActiveDirectory or Mantis or SourceOffSite</AuthType>
            <AuthDomain>string</AuthDomain>
            <AccessInfo xsi:nil="true" />
            <UserType>RegularUser or WebOnlyUser</UserType>
            <UserID>int</UserID>
            <Login>string</Login>
            <Name>string</Name>
            <Password>string</Password>
            <Email>string</Email>
            <Description>string</Description>
            <isActive>boolean</isActive>
            <Status>int</Status>
            <DefaultRights>unsignedInt</DefaultRights>
            <FolderRights xsi:nil="true" />
            <BelongToGroups xsi:nil="true" />
          </VaultUser>
          <VaultUser>
            <AuthType>Vault or ActiveDirectory or Mantis or SourceOffSite</AuthType>
            <AuthDomain>string</AuthDomain>
            <AccessInfo xsi:nil="true" />
            <UserType>RegularUser or WebOnlyUser</UserType>
            <UserID>int</UserID>
            <Login>string</Login>
            <Name>string</Name>
            <Password>string</Password>
            <Email>string</Email>
            <Description>string</Description>
            <isActive>boolean</isActive>
            <Status>int</Status>
            <DefaultRights>unsignedInt</DefaultRights>
            <FolderRights xsi:nil="true" />
            <BelongToGroups xsi:nil="true" />
          </VaultUser>
        </Users>
        <Actions>
          <long>long</long>
          <long>long</long>
        </Actions>
        <CommentFilter>int</CommentFilter>
        <CommentSubstring>string</CommentSubstring>
        <Sorts>
          <long>long</long>
          <long>long</long>
        </Sorts>
      </reqHQ>
      <nRowLimit>int</nRowLimit>
      <nRowsRetrieved>int</nRowsRetrieved>
      <strQryToken>string</strQryToken>
    </BeginHistoryQuery>
  </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>
    <BeginHistoryQueryResponse xmlns="http://www.sourcegear.com/schemas/vault">
      <BeginHistoryQueryResult>int</BeginHistoryQueryResult>
      <nRowsRetrieved>int</nRowsRetrieved>
      <strQryToken>string</strQryToken>
    </BeginHistoryQueryResponse>
  </soap12:Body>
</soap12:Envelope>