Reference for GetAgentDashboardInfo

Url: status/dashboard/{agentId}

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"?>
    <agentDashboardInfo xmlns="http://apprecovery.com/management/api/2010/05">
      <agentType>Protected</agentType>
      <displayName>String content</displayName>
      <failedChecksCount>2147483647</failedChecksCount>
      <hostname>String content</hostname>
      <id>1627aea5-8e0a-4371-9022-9b504344e724</id>
      <inconsistentRecoveryPointsCount>2147483647</inconsistentRecoveryPointsCount>
      <isCluster>true</isCluster>
      <isLicenseExpired>true</isLicenseExpired>
      <isProtectionPaused>true</isProtectionPaused>
      <newestRpUtcCreateTimestamp>1999-05-31T11:20:00</newestRpUtcCreateTimestamp>
      <oldestRpUtcCreateTimestamp>1999-05-31T11:20:00</oldestRpUtcCreateTimestamp>
      <parentAgentId>1627aea5-8e0a-4371-9022-9b504344e724</parentAgentId>
      <parentClusterId>1627aea5-8e0a-4371-9022-9b504344e724</parentClusterId>
      <passedChecksCount>2147483647</passedChecksCount>
      <protectedDataBytes>18446744073709551615</protectedDataBytes>
      <recoveryPointCount>4294967295</recoveryPointCount>
      <repositoryName>String content</repositoryName>
      <repositoryStatus>Unknown</repositoryStatus>
      <requiredChecksCount>2147483647</requiredChecksCount>
      <status>Online</status>
    </agentDashboardInfo>

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: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.Agents" />
        <xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" />
        <xs:import namespace="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Repositories" />
        <xs:complexType name="agentDashboardInfo">
          <xs:sequence>
            <xs:element minOccurs="0" name="agentType" xmlns:q1="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Agents" type="q1:AgentType" />
            <xs:element minOccurs="0" name="displayName" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="failedChecksCount" type="xs:int" />
            <xs:element minOccurs="0" name="hostname" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="id" type="ser:guid" />
            <xs:element minOccurs="0" name="inconsistentRecoveryPointsCount" type="xs:int" />
            <xs:element minOccurs="0" name="isCluster" type="xs:boolean" />
            <xs:element minOccurs="0" name="isLicenseExpired" type="xs:boolean" />
            <xs:element minOccurs="0" name="isProtectionPaused" type="xs:boolean" />
            <xs:element minOccurs="0" name="newestRpUtcCreateTimestamp" nillable="true" type="xs:dateTime" />
            <xs:element minOccurs="0" name="oldestRpUtcCreateTimestamp" nillable="true" type="xs:dateTime" />
            <xs:element minOccurs="0" name="parentAgentId" type="ser:guid" />
            <xs:element minOccurs="0" name="parentClusterId" type="ser:guid" />
            <xs:element minOccurs="0" name="passedChecksCount" type="xs:int" />
            <xs:element minOccurs="0" name="protectedDataBytes" nillable="true" type="xs:unsignedLong" />
            <xs:element minOccurs="0" name="recoveryPointCount" nillable="true" type="xs:unsignedInt" />
            <xs:element minOccurs="0" name="repositoryName" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="repositoryStatus" xmlns:q2="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Repositories" type="q2:RepositoryStatus" />
            <xs:element minOccurs="0" name="requiredChecksCount" type="xs:int" />
            <xs:element minOccurs="0" name="status" xmlns:q3="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Agents" type="q3:AgentStatus" />
          </xs:sequence>
        </xs:complexType>
        <xs:element name="agentDashboardInfo" nillable="true" type="tns:agentDashboardInfo" />
      </xs:schema>
      <xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Agents" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Agents" xmlns:xs="http://www.w3.org/2001/XMLSchema">
        <xs:simpleType name="AgentType">
          <xs:restriction base="xs:string">
            <xs:enumeration value="Protected" />
            <xs:enumeration value="Replicated" />
            <xs:enumeration value="PendingFailover" />
            <xs:enumeration value="Failover" />
            <xs:enumeration value="ClusterNode" />
            <xs:enumeration value="Cluster" />
            <xs:enumeration value="RecoveryPointsOnly" />
            <xs:enumeration value="EsxServer" />
            <xs:enumeration value="EsxVirtualMachine" />
            <xs:enumeration value="Backup" />
            <xs:enumeration value="Unknown" />
            <xs:enumeration value="HyperVServer" />
            <xs:enumeration value="HyperVVirtualMachine" />
            <xs:enumeration value="HyperVCluster" />
          </xs:restriction>
        </xs:simpleType>
        <xs:element name="AgentType" nillable="true" type="tns:AgentType" />
        <xs:simpleType name="AgentStatus">
          <xs:restriction base="xs:string">
            <xs:enumeration value="Online" />
            <xs:enumeration value="PendingFailover" />
            <xs:enumeration value="Unreachable" />
            <xs:enumeration value="AuthenticationError" />
            <xs:enumeration value="Failed" />
            <xs:enumeration value="Loading" />
          </xs:restriction>
        </xs:simpleType>
        <xs:element name="AgentStatus" nillable="true" type="tns:AgentStatus" />
      </xs:schema>
      <xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Repositories" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Repositories" xmlns:xs="http://www.w3.org/2001/XMLSchema">
        <xs:simpleType name="RepositoryStatus">
          <xs:restriction base="xs:string">
            <xs:enumeration value="Unknown" />
            <xs:enumeration value="Unmounting" />
            <xs:enumeration value="Unmounted" />
            <xs:enumeration value="Mounting" />
            <xs:enumeration value="Mounted" />
            <xs:enumeration value="Maintenance" />
            <xs:enumeration value="Error" />
            <xs:enumeration value="ServerMaintenance" />
          </xs:restriction>
        </xs:simpleType>
        <xs:element name="RepositoryStatus" nillable="true" type="tns:RepositoryStatus" />
      </xs:schema>
    </Schemas>