VaultService Web Service

VaultService

Click here for a complete list of operations.

BeginHistoryFavoriteQuery

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

<?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>
    <BeginHistoryFavoriteQuery xmlns="http://www.sourcegear.com/schemas/vault">
      <vhFav>
        <Name>string</Name>
        <ID>int</ID>
        <QueryRequest>
          <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 xsi:nil="true" />
            <VaultUser xsi:nil="true" />
          </Users>
          <Actions>
            <long>long</long>
            <long>long</long>
          </Actions>
          <CommentFilter>int</CommentFilter>
          <CommentSubstring>string</CommentSubstring>
          <Sorts>
            <long>long</long>
            <long>long</long>
          </Sorts>
        </QueryRequest>
        <QueryType>unsignedByte</QueryType>
        <IncludeVersionLabels>boolean</IncludeVersionLabels>
      </vhFav>
      <nRowLimit>int</nRowLimit>
      <nRowsRetrieved>int</nRowsRetrieved>
      <strQryToken>string</strQryToken>
    </BeginHistoryFavoriteQuery>
  </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>
    <BeginHistoryFavoriteQueryResponse xmlns="http://www.sourcegear.com/schemas/vault">
      <BeginHistoryFavoriteQueryResult>int</BeginHistoryFavoriteQueryResult>
      <vhFav>
        <Name>string</Name>
        <ID>int</ID>
        <QueryRequest>
          <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 xsi:nil="true" />
            <VaultUser xsi:nil="true" />
          </Users>
          <Actions>
            <long>long</long>
            <long>long</long>
          </Actions>
          <CommentFilter>int</CommentFilter>
          <CommentSubstring>string</CommentSubstring>
          <Sorts>
            <long>long</long>
            <long>long</long>
          </Sorts>
        </QueryRequest>
        <QueryType>unsignedByte</QueryType>
        <IncludeVersionLabels>boolean</IncludeVersionLabels>
      </vhFav>
      <nRowsRetrieved>int</nRowsRetrieved>
      <strQryToken>string</strQryToken>
    </BeginHistoryFavoriteQueryResponse>
  </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>
    <BeginHistoryFavoriteQuery xmlns="http://www.sourcegear.com/schemas/vault">
      <vhFav>
        <Name>string</Name>
        <ID>int</ID>
        <QueryRequest>
          <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 xsi:nil="true" />
            <VaultUser xsi:nil="true" />
          </Users>
          <Actions>
            <long>long</long>
            <long>long</long>
          </Actions>
          <CommentFilter>int</CommentFilter>
          <CommentSubstring>string</CommentSubstring>
          <Sorts>
            <long>long</long>
            <long>long</long>
          </Sorts>
        </QueryRequest>
        <QueryType>unsignedByte</QueryType>
        <IncludeVersionLabels>boolean</IncludeVersionLabels>
      </vhFav>
      <nRowLimit>int</nRowLimit>
      <nRowsRetrieved>int</nRowsRetrieved>
      <strQryToken>string</strQryToken>
    </BeginHistoryFavoriteQuery>
  </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>
    <BeginHistoryFavoriteQueryResponse xmlns="http://www.sourcegear.com/schemas/vault">
      <BeginHistoryFavoriteQueryResult>int</BeginHistoryFavoriteQueryResult>
      <vhFav>
        <Name>string</Name>
        <ID>int</ID>
        <QueryRequest>
          <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 xsi:nil="true" />
            <VaultUser xsi:nil="true" />
          </Users>
          <Actions>
            <long>long</long>
            <long>long</long>
          </Actions>
          <CommentFilter>int</CommentFilter>
          <CommentSubstring>string</CommentSubstring>
          <Sorts>
            <long>long</long>
            <long>long</long>
          </Sorts>
        </QueryRequest>
        <QueryType>unsignedByte</QueryType>
        <IncludeVersionLabels>boolean</IncludeVersionLabels>
      </vhFav>
      <nRowsRetrieved>int</nRowsRetrieved>
      <strQryToken>string</strQryToken>
    </BeginHistoryFavoriteQueryResponse>
  </soap12:Body>
</soap12:Envelope>