Reference for StartDataTransfer

Url: hypervTransferDirectToTarget/snapshots/{snapshotSetId}/o3e/transfervolume/{volumeName}

HTTP Method: POST

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

The following is an example request XML body:

<?xml version="1.0" encoding="utf-16"?>
<o3EVolumeTransferParameters xmlns="http://apprecovery.com/management/api/2010/05">
  <bitmapBlocksCapacity>18446744073709551615</bitmapBlocksCapacity>
  <capacityBytes>18446744073709551615</capacityBytes>
  <compressedBitmap>QmFzZSA2NCBTdHJlYW0=</compressedBitmap>
  <encryptionKey>QmFzZSA2NCBTdHJlYW0=</encryptionKey>
  <isAfterRollback>true</isAfterRollback>
  <isIncremental>true</isIncremental>
  <isPartial>true</isPartial>
  <lowLevelConfiguration>
    <archiveAndReplicationDataCacheCapacity>4294967295</archiveAndReplicationDataCacheCapacity>
    <archiveAndReplicationReadThreads>65535</archiveAndReplicationReadThreads>
    <clientSideDeduplication>true</clientSideDeduplication>
    <dataProcessingPipelineMaxThreads>65535</dataProcessingPipelineMaxThreads>
    <enableArchiveAndReplicationCompression>true</enableArchiveAndReplicationCompression>
    <enableAutoCleaner>true</enableAutoCleaner>
    <enableBeforehandIncrementalClone>true</enableBeforehandIncrementalClone>
    <enableMetadataCaching>true</enableMetadataCaching>
    <enableOtherSnapshotComponentsIntegrityChecksumCalculation>true</enableOtherSnapshotComponentsIntegrityChecksumCalculation>
    <enableVolumeSnapshotIntegrityChecksumCalculation>true</enableVolumeSnapshotIntegrityChecksumCalculation>
    <forceCompressionWhenEncryptionIsEnabled>true</forceCompressionWhenEncryptionIsEnabled>
    <maxConcurrentClones>4294967295</maxConcurrentClones>
    <migrationFlushAfterBytes>9223372036854775807</migrationFlushAfterBytes>
    <migrationIndividualBitmapCachePath>String content</migrationIndividualBitmapCachePath>
    <migrationWriteThreads>65535</migrationWriteThreads>
    <readBufferSize_x0020_>4294967295</readBufferSize_x0020_>
    <replicationFlushAfterBytes>9223372036854775807</replicationFlushAfterBytes>
    <replicationIndividualBitmapCachePath>String content</replicationIndividualBitmapCachePath>
    <snapshotCheckMaxErrors>4294967295</snapshotCheckMaxErrors>
    <writeBufferSize>4294967295</writeBufferSize>
  </lowLevelConfiguration>
  <parallelWrites>4294967295</parallelWrites>
  <rollbackSnapshotScid>18446744073709551615</rollbackSnapshotScid>
  <snapshotFileName>String content</snapshotFileName>
  <volumeId>1627aea5-8e0a-4371-9022-9b504344e724</volumeId>
</o3EVolumeTransferParameters>

The following is an example response XML body:

No Xml response output for this method.

The following is the request 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:ser="http://schemas.microsoft.com/2003/10/Serialization/" 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.microsoft.com/2003/10/Serialization/" />
    <xs:complexType name="o3EVolumeTransferParameters">
      <xs:sequence>
        <xs:element minOccurs="0" name="bitmapBlocksCapacity" type="xs:unsignedLong" />
        <xs:element minOccurs="0" name="capacityBytes" type="xs:unsignedLong" />
        <xs:element minOccurs="0" name="compressedBitmap" nillable="true" type="xs:base64Binary" />
        <xs:element minOccurs="0" name="encryptionKey" nillable="true" type="xs:base64Binary" />
        <xs:element minOccurs="0" name="isAfterRollback" type="xs:boolean" />
        <xs:element minOccurs="0" name="isIncremental" type="xs:boolean" />
        <xs:element minOccurs="0" name="isPartial" type="xs:boolean" />
        <xs:element minOccurs="0" name="lowLevelConfiguration" nillable="true" type="tns:o3ePhantomLowLevelConfiguration" />
        <xs:element minOccurs="0" name="parallelWrites" type="xs:unsignedInt" />
        <xs:element minOccurs="0" name="rollbackSnapshotScid" type="xs:unsignedLong" />
        <xs:element minOccurs="0" name="snapshotFileName" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="volumeId" type="ser:guid" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="o3EVolumeTransferParameters" nillable="true" type="tns:o3EVolumeTransferParameters" />
    <xs:complexType name="o3ePhantomLowLevelConfiguration">
      <xs:sequence>
        <xs:element minOccurs="0" name="archiveAndReplicationDataCacheCapacity" type="xs:unsignedInt" />
        <xs:element minOccurs="0" name="archiveAndReplicationReadThreads" type="xs:unsignedShort" />
        <xs:element minOccurs="0" name="clientSideDeduplication" type="xs:boolean" />
        <xs:element minOccurs="0" name="dataProcessingPipelineMaxThreads" type="xs:unsignedShort" />
        <xs:element minOccurs="0" name="enableArchiveAndReplicationCompression" type="xs:boolean" />
        <xs:element minOccurs="0" name="enableAutoCleaner" type="xs:boolean" />
        <xs:element minOccurs="0" name="enableBeforehandIncrementalClone" type="xs:boolean" />
        <xs:element minOccurs="0" name="enableMetadataCaching" type="xs:boolean" />
        <xs:element minOccurs="0" name="enableOtherSnapshotComponentsIntegrityChecksumCalculation" type="xs:boolean" />
        <xs:element minOccurs="0" name="enableVolumeSnapshotIntegrityChecksumCalculation" type="xs:boolean" />
        <xs:element minOccurs="0" name="forceCompressionWhenEncryptionIsEnabled" type="xs:boolean" />
        <xs:element minOccurs="0" name="maxConcurrentClones" type="xs:unsignedInt" />
        <xs:element minOccurs="0" name="migrationFlushAfterBytes" type="xs:long" />
        <xs:element minOccurs="0" name="migrationIndividualBitmapCachePath" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="migrationWriteThreads" type="xs:unsignedShort" />
        <xs:element minOccurs="0" name="readBufferSize_x0020_" type="xs:unsignedInt" />
        <xs:element minOccurs="0" name="replicationFlushAfterBytes" type="xs:long" />
        <xs:element minOccurs="0" name="replicationIndividualBitmapCachePath" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="snapshotCheckMaxErrors" type="xs:unsignedInt" />
        <xs:element minOccurs="0" name="writeBufferSize" type="xs:unsignedInt" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="o3ePhantomLowLevelConfiguration" nillable="true" type="tns:o3ePhantomLowLevelConfiguration" />
  </xs:schema>
</Schemas>

The following is the response XML Schema:

The response body is empty.