Reference for GetDataTransferProgress

Url: hypervTransferDirectToTarget/snapshots/{snapshotSetId}/o3e/progress

HTTP Method: GET

Message direction	Format	Body
Request	XML	Example,Schema
Response	XML	Example,Schema

The following is an example request XML body:

No Xml request body for this method. False

The following is an example response XML body:

<?xml version="1.0" encoding="utf-16"?>
<transferProgressInfo xmlns="http://apprecovery.com/management/api/2010/05">
  <error>
    <message>String content</message>
    <type>String content</type>
    <detail>String content</detail>
    <stackTrace>String content</stackTrace>
    <serverException>
      <message>String content</message>
      <type>String content</type>
      <detail>String content</detail>
      <rawException>QmFzZSA2NCBTdHJlYW0=</rawException>
    </serverException>
  </error>
  <snapshotFileScid>18446744073709551615</snapshotFileScid>
  <totalBytesToTransfer>18446744073709551615</totalBytesToTransfer>
  <transferStage>None</transferStage>
  <transferred>18446744073709551615</transferred>
</transferProgressInfo>

The following is the request XML Schema:

The request body is empty.

The following is the response XML Schema:

<?xml version="1.0" encoding="utf-16"?>
<Schemas>
  <xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="anyType" nillable="true" type="xs:anyType" />
    <xs:element name="anyURI" nillable="true" type="xs:anyURI" />
    <xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
    <xs:element name="boolean" nillable="true" type="xs:boolean" />
    <xs:element name="byte" nillable="true" type="xs:byte" />
    <xs:element name="dateTime" nillable="true" type="xs:dateTime" />
    <xs:element name="decimal" nillable="true" type="xs:decimal" />
    <xs:element name="double" nillable="true" type="xs:double" />
    <xs:element name="float" nillable="true" type="xs:float" />
    <xs:element name="int" nillable="true" type="xs:int" />
    <xs:element name="long" nillable="true" type="xs:long" />
    <xs:element name="QName" nillable="true" type="xs:QName" />
    <xs:element name="short" nillable="true" type="xs:short" />
    <xs:element name="string" nillable="true" type="xs:string" />
    <xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
    <xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
    <xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
    <xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
    <xs:element name="char" nillable="true" type="tns:char" />
    <xs:simpleType name="char">
      <xs:restriction base="xs:int" />
    </xs:simpleType>
    <xs:element name="duration" nillable="true" type="tns:duration" />
    <xs:simpleType name="duration">
      <xs:restriction base="xs:duration">
        <xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
        <xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
        <xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
      </xs:restriction>
    </xs:simpleType>
    <xs:element name="guid" nillable="true" type="tns:guid" />
    <xs:simpleType name="guid">
      <xs:restriction base="xs:string">
        <xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
      </xs:restriction>
    </xs:simpleType>
    <xs:attribute name="FactoryType" type="xs:QName" />
    <xs:attribute name="Id" type="xs:ID" />
    <xs:attribute name="Ref" type="xs:IDREF" />
  </xs:schema>
  <xs:schema xmlns:tns="http://apprecovery.com/management/api/2010/05" elementFormDefault="qualified" targetNamespace="http://apprecovery.com/management/api/2010/05" xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:import namespace="http://schemas.datacontract.org/2004/07/Replay.Agent.Contracts.Transfer" />
    <xs:complexType name="transferProgressInfo">
      <xs:sequence>
        <xs:element minOccurs="0" name="error" nillable="true" type="tns:serverError" />
        <xs:element minOccurs="0" name="snapshotFileScid" type="xs:unsignedLong" />
        <xs:element minOccurs="0" name="totalBytesToTransfer" type="xs:unsignedLong" />
        <xs:element minOccurs="0" name="transferStage" xmlns:q1="http://schemas.datacontract.org/2004/07/Replay.Agent.Contracts.Transfer" type="q1:O3EDirectToTargetTransferStage" />
        <xs:element minOccurs="0" name="transferred" type="xs:unsignedLong" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="transferProgressInfo" nillable="true" type="tns:transferProgressInfo" />
    <xs:complexType name="serverError">
      <xs:sequence>
        <xs:element minOccurs="0" name="message" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="type" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="detail" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="stackTrace" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="serverException" nillable="true" type="tns:exception" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="serverError" nillable="true" type="tns:serverError" />
    <xs:complexType name="exception">
      <xs:sequence>
        <xs:element minOccurs="0" name="message" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="type" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="detail" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="rawException" nillable="true" type="xs:base64Binary">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
    <xs:element name="exception" nillable="true" type="tns:exception" />
  </xs:schema>
  <xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/Replay.Agent.Contracts.Transfer" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/Replay.Agent.Contracts.Transfer" xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:simpleType name="O3EDirectToTargetTransferStage">
      <xs:restriction base="xs:string">
        <xs:enumeration value="None" />
        <xs:enumeration value="CreatingSnapshotFile" />
        <xs:enumeration value="Transferring" />
        <xs:enumeration value="Finished" />
      </xs:restriction>
    </xs:simpleType>
    <xs:element name="O3EDirectToTargetTransferStage" nillable="true" type="tns:O3EDirectToTargetTransferStage" />
  </xs:schema>
</Schemas>