GET api/Monitoring

Returns a list of monitoring structures that are available to users

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of MonitoringModels
NameDescriptionTypeAdditional information
PlanName

Plan name.

string

None.

CompanyName

Company name

string

None.

UserName

User email.

string

None.

UserID

User unique identifier

string

None.

ComputerName

Computer name.

string

None.

BuildVersion

Build version.

string

None.

StorageType

Storage type

string

None.

LastStart

Last start

date

None.

NextStart

Next run.

date

None.

Status

Status of plan.

MonitoringPlanStatus

None.

ErrorMessage

Error message.

string

None.

FilesCopied

Files Copied

integer

None.

FilesFailed

Files Failed

integer

None.

DataCopied

Size Data Copied

integer

None.

Duration

Duration of Operation

string

None.

DataToBackup

Size Data To Backup

integer

None.

TotalData

Size Total Data

integer

None.

FilesScanned

Files Scanned

integer

None.

FilesToBackup

Files To Backup

integer

None.

PlanId

Plan unique identifier

string

None.

PlanType

Plan Type

MonitoringPlanType

None.

DetailedReportLink

Detailed Report Link

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "PlanName": "sample string 1",
    "CompanyName": "sample string 2",
    "UserName": "sample string 3",
    "UserID": "sample string 4",
    "ComputerName": "sample string 5",
    "BuildVersion": "sample string 6",
    "StorageType": "sample string 7",
    "LastStart": "2019-10-15T16:51:11.2157616+00:00",
    "NextStart": "2019-10-15T16:51:11.2157616+00:00",
    "Status": 0,
    "ErrorMessage": "sample string 8",
    "FilesCopied": 9,
    "FilesFailed": 10,
    "DataCopied": 11,
    "Duration": "sample string 12",
    "DataToBackup": 13,
    "TotalData": 14,
    "FilesScanned": 15,
    "FilesToBackup": 16,
    "PlanId": "sample string 17",
    "PlanType": 0,
    "DetailedReportLink": "sample string 18"
  },
  {
    "PlanName": "sample string 1",
    "CompanyName": "sample string 2",
    "UserName": "sample string 3",
    "UserID": "sample string 4",
    "ComputerName": "sample string 5",
    "BuildVersion": "sample string 6",
    "StorageType": "sample string 7",
    "LastStart": "2019-10-15T16:51:11.2157616+00:00",
    "NextStart": "2019-10-15T16:51:11.2157616+00:00",
    "Status": 0,
    "ErrorMessage": "sample string 8",
    "FilesCopied": 9,
    "FilesFailed": 10,
    "DataCopied": 11,
    "Duration": "sample string 12",
    "DataToBackup": 13,
    "TotalData": 14,
    "FilesScanned": 15,
    "FilesToBackup": 16,
    "PlanId": "sample string 17",
    "PlanType": 0,
    "DetailedReportLink": "sample string 18"
  }
]

application/xml, text/xml

Sample:
<ArrayOfMonitoringModels xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MBSAPImvc.Engine.Models">
  <MonitoringModels>
    <BuildVersion>sample string 6</BuildVersion>
    <CompanyName>sample string 2</CompanyName>
    <ComputerName>sample string 5</ComputerName>
    <DataCopied>11</DataCopied>
    <DataToBackup>13</DataToBackup>
    <DetailedReportLink>sample string 18</DetailedReportLink>
    <Duration>sample string 12</Duration>
    <ErrorMessage>sample string 8</ErrorMessage>
    <FilesCopied>9</FilesCopied>
    <FilesFailed>10</FilesFailed>
    <FilesScanned>15</FilesScanned>
    <FilesToBackup>16</FilesToBackup>
    <LastStart>2019-10-15T16:51:11.2157616+00:00</LastStart>
    <NextStart>2019-10-15T16:51:11.2157616+00:00</NextStart>
    <PlanId>sample string 17</PlanId>
    <PlanName>sample string 1</PlanName>
    <PlanType>NA</PlanType>
    <Status>Success</Status>
    <StorageType>sample string 7</StorageType>
    <TotalData>14</TotalData>
    <UserID>sample string 4</UserID>
    <UserName>sample string 3</UserName>
  </MonitoringModels>
  <MonitoringModels>
    <BuildVersion>sample string 6</BuildVersion>
    <CompanyName>sample string 2</CompanyName>
    <ComputerName>sample string 5</ComputerName>
    <DataCopied>11</DataCopied>
    <DataToBackup>13</DataToBackup>
    <DetailedReportLink>sample string 18</DetailedReportLink>
    <Duration>sample string 12</Duration>
    <ErrorMessage>sample string 8</ErrorMessage>
    <FilesCopied>9</FilesCopied>
    <FilesFailed>10</FilesFailed>
    <FilesScanned>15</FilesScanned>
    <FilesToBackup>16</FilesToBackup>
    <LastStart>2019-10-15T16:51:11.2157616+00:00</LastStart>
    <NextStart>2019-10-15T16:51:11.2157616+00:00</NextStart>
    <PlanId>sample string 17</PlanId>
    <PlanName>sample string 1</PlanName>
    <PlanType>NA</PlanType>
    <Status>Success</Status>
    <StorageType>sample string 7</StorageType>
    <TotalData>14</TotalData>
    <UserID>sample string 4</UserID>
    <UserName>sample string 3</UserName>
  </MonitoringModels>
</ArrayOfMonitoringModels>