Reference for ValidateRetentionPolicyByAgent

Url: rollup/validatePolicyByAgent/{agentId}

HTTP Method: PUT

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"?>
    <retentionPolicy xmlns="http://apprecovery.com/management/api/2010/05">
      <keepAlls>
        <_x003C_Enabled_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Rollup">true</_x003C_Enabled_x003E_k__BackingField>
        <_x003C_Quantity_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Rollup">2147483647</_x003C_Quantity_x003E_k__BackingField>
        <_x003C_Unit_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Rollup">Days</_x003C_Unit_x003E_k__BackingField>
      </keepAlls>
      <keepOnePerDay>
        <_x003C_Enabled_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Rollup">true</_x003C_Enabled_x003E_k__BackingField>
        <_x003C_Quantity_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Rollup">2147483647</_x003C_Quantity_x003E_k__BackingField>
        <_x003C_Unit_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Rollup">Days</_x003C_Unit_x003E_k__BackingField>
      </keepOnePerDay>
      <keepOnePerHour>
        <_x003C_Enabled_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Rollup">true</_x003C_Enabled_x003E_k__BackingField>
        <_x003C_Quantity_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Rollup">2147483647</_x003C_Quantity_x003E_k__BackingField>
        <_x003C_Unit_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Rollup">Days</_x003C_Unit_x003E_k__BackingField>
      </keepOnePerHour>
      <keepOnePerMonth>
        <_x003C_Enabled_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Rollup">true</_x003C_Enabled_x003E_k__BackingField>
        <_x003C_Quantity_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Rollup">2147483647</_x003C_Quantity_x003E_k__BackingField>
        <_x003C_Unit_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Rollup">Days</_x003C_Unit_x003E_k__BackingField>
      </keepOnePerMonth>
      <keepOnePerWeek>
        <_x003C_Enabled_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Rollup">true</_x003C_Enabled_x003E_k__BackingField>
        <_x003C_Quantity_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Rollup">2147483647</_x003C_Quantity_x003E_k__BackingField>
        <_x003C_Unit_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Rollup">Days</_x003C_Unit_x003E_k__BackingField>
      </keepOnePerWeek>
      <keepOnePerYear>
        <_x003C_Enabled_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Rollup">true</_x003C_Enabled_x003E_k__BackingField>
        <_x003C_Quantity_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Rollup">2147483647</_x003C_Quantity_x003E_k__BackingField>
        <_x003C_Unit_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Rollup">Days</_x003C_Unit_x003E_k__BackingField>
      </keepOnePerYear>
      <relocateOutdated>
        <relocationScope>
          <_x003C_Enabled_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Rollup">true</_x003C_Enabled_x003E_k__BackingField>
          <_x003C_Quantity_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Rollup">2147483647</_x003C_Quantity_x003E_k__BackingField>
          <_x003C_Unit_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Rollup">Days</_x003C_Unit_x003E_k__BackingField>
        </relocationScope>
        <targetRepositoryId>1627aea5-8e0a-4371-9022-9b504344e724</targetRepositoryId>
      </relocateOutdated>
    </retentionPolicy>

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.datacontract.org/2004/07/Replay.Core.Contracts.Rollup" />
        <xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" />
        <xs:complexType name="retentionPolicy">
          <xs:sequence>
            <xs:element minOccurs="0" name="keepAlls" nillable="true" xmlns:q1="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Rollup" type="q1:RetentionDuration" />
            <xs:element minOccurs="0" name="keepOnePerDay" nillable="true" xmlns:q2="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Rollup" type="q2:RetentionDuration" />
            <xs:element minOccurs="0" name="keepOnePerHour" nillable="true" xmlns:q3="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Rollup" type="q3:RetentionDuration" />
            <xs:element minOccurs="0" name="keepOnePerMonth" nillable="true" xmlns:q4="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Rollup" type="q4:RetentionDuration" />
            <xs:element minOccurs="0" name="keepOnePerWeek" nillable="true" xmlns:q5="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Rollup" type="q5:RetentionDuration" />
            <xs:element minOccurs="0" name="keepOnePerYear" nillable="true" xmlns:q6="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Rollup" type="q6:RetentionDuration" />
            <xs:element minOccurs="0" name="relocateOutdated" nillable="true" type="tns:relocationConfiguration" />
          </xs:sequence>
        </xs:complexType>
        <xs:element name="retentionPolicy" nillable="true" type="tns:retentionPolicy" />
        <xs:complexType name="relocationConfiguration">
          <xs:sequence>
            <xs:element minOccurs="0" name="relocationScope" nillable="true" xmlns:q7="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Rollup" type="q7:RetentionDuration" />
            <xs:element minOccurs="0" name="targetRepositoryId" type="ser:guid" />
          </xs:sequence>
        </xs:complexType>
        <xs:element name="relocationConfiguration" nillable="true" type="tns:relocationConfiguration" />
      </xs:schema>
      <xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Rollup" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Rollup" xmlns:xs="http://www.w3.org/2001/XMLSchema">
        <xs:complexType name="RetentionDuration">
          <xs:sequence>
            <xs:element name="_x003C_Enabled_x003E_k__BackingField" type="xs:boolean" />
            <xs:element name="_x003C_Quantity_x003E_k__BackingField" type="xs:int" />
            <xs:element name="_x003C_Unit_x003E_k__BackingField" type="tns:RetentionUnit" />
          </xs:sequence>
        </xs:complexType>
        <xs:element name="RetentionDuration" nillable="true" type="tns:RetentionDuration" />
        <xs:simpleType name="RetentionUnit">
          <xs:restriction base="xs:string">
            <xs:enumeration value="Days" />
            <xs:enumeration value="Weeks" />
            <xs:enumeration value="Months" />
            <xs:enumeration value="Years" />
          </xs:restriction>
        </xs:simpleType>
        <xs:element name="RetentionUnit" nillable="true" type="tns:RetentionUnit" />
      </xs:schema>
    </Schemas>

The following is the response XML Schema:

    The response body is empty.