GET datacollectors?customerID={customerID}

Get all DataCollector clients for a customer Roles: ApiRole/FreeRole

Request Information

URI Parameters

NameDescriptionTypeAdditional information
customerID

Customer ID

integer

Required

Body Parameters

None.

Response Information

Resource Description

Returns all DataCollectors for a customer as a queryable object.

Collection of DCClient
NameDescriptionTypeAdditional information
ClientID

Client ID

integer

None.

AccountID

Customer/Account ID

integer

None.

Name

Client name

string

None.

Created

Client created date

date

None.

LastDiscovered

Client last Discovered

date

None.

LastCollect

Client last collect

date

None.

LastActivity

Client last activity

date

None.

IPv4

IPv4 address of client installed machine

string

None.

Version

Client version

string

None.

IsActivated

Is client activated

boolean

None.

IsInUse

Is client in use

boolean

None.

Ranges

Client ranges.

Collection of DCClientRange

None.

State

Client state

ClientState

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ClientID": 1,
    "AccountID": 2,
    "Name": "sample string 3",
    "Created": "2018-10-20T01:43:53.8165708+00:00",
    "LastDiscovered": "2018-10-20T01:43:53.8165708+00:00",
    "LastCollect": "2018-10-20T01:43:53.8165708+00:00",
    "LastActivity": "2018-10-20T01:43:53.8165708+00:00",
    "AllowedOffline": "00:00:00.1234567",
    "IPv4": "sample string 9",
    "Version": "sample string 10",
    "IsActivated": true,
    "IsInUse": true,
    "Ranges": [
      {
        "ClientRangeID": 1,
        "ClientID": 2,
        "Name": "sample string 3",
        "StartIP": "sample string 4",
        "EndIP": "sample string 5",
        "State": "sample string 6",
        "IsEnabled": true,
        "Community": "sample string 8",
        "NumOfDevices": 1,
        "Created": "2018-10-20T01:43:53.8165708+00:00",
        "Comment": "sample string 10",
        "Exclude": true
      },
      {
        "ClientRangeID": 1,
        "ClientID": 2,
        "Name": "sample string 3",
        "StartIP": "sample string 4",
        "EndIP": "sample string 5",
        "State": "sample string 6",
        "IsEnabled": true,
        "Community": "sample string 8",
        "NumOfDevices": 1,
        "Created": "2018-10-20T01:43:53.8165708+00:00",
        "Comment": "sample string 10",
        "Exclude": true
      }
    ],
    "State": "Online"
  },
  {
    "ClientID": 1,
    "AccountID": 2,
    "Name": "sample string 3",
    "Created": "2018-10-20T01:43:53.8165708+00:00",
    "LastDiscovered": "2018-10-20T01:43:53.8165708+00:00",
    "LastCollect": "2018-10-20T01:43:53.8165708+00:00",
    "LastActivity": "2018-10-20T01:43:53.8165708+00:00",
    "AllowedOffline": "00:00:00.1234567",
    "IPv4": "sample string 9",
    "Version": "sample string 10",
    "IsActivated": true,
    "IsInUse": true,
    "Ranges": [
      {
        "ClientRangeID": 1,
        "ClientID": 2,
        "Name": "sample string 3",
        "StartIP": "sample string 4",
        "EndIP": "sample string 5",
        "State": "sample string 6",
        "IsEnabled": true,
        "Community": "sample string 8",
        "NumOfDevices": 1,
        "Created": "2018-10-20T01:43:53.8165708+00:00",
        "Comment": "sample string 10",
        "Exclude": true
      },
      {
        "ClientRangeID": 1,
        "ClientID": 2,
        "Name": "sample string 3",
        "StartIP": "sample string 4",
        "EndIP": "sample string 5",
        "State": "sample string 6",
        "IsEnabled": true,
        "Community": "sample string 8",
        "NumOfDevices": 1,
        "Created": "2018-10-20T01:43:53.8165708+00:00",
        "Comment": "sample string 10",
        "Exclude": true
      }
    ],
    "State": "Online"
  }
]

application/xml, text/xml

Sample:
<ArrayOfDCClient xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <DCClient>
    <ClientID>1</ClientID>
    <AccountID>2</AccountID>
    <Name>sample string 3</Name>
    <Created>2018-10-20T01:43:53.8165708+00:00</Created>
    <LastDiscovered>2018-10-20T01:43:53.8165708+00:00</LastDiscovered>
    <LastCollect>2018-10-20T01:43:53.8165708+00:00</LastCollect>
    <LastActivity>2018-10-20T01:43:53.8165708+00:00</LastActivity>
    <IPv4>sample string 9</IPv4>
    <Version>sample string 10</Version>
    <IsActivated>true</IsActivated>
    <IsInUse>true</IsInUse>
    <Ranges>
      <DCClientRange>
        <ClientRangeID>1</ClientRangeID>
        <ClientID>2</ClientID>
        <Name>sample string 3</Name>
        <StartIP>sample string 4</StartIP>
        <EndIP>sample string 5</EndIP>
        <State>sample string 6</State>
        <IsEnabled>true</IsEnabled>
        <Community>sample string 8</Community>
        <NumOfDevices>1</NumOfDevices>
        <Created>2018-10-20T01:43:53.8165708+00:00</Created>
        <Comment>sample string 10</Comment>
        <Exclude>true</Exclude>
      </DCClientRange>
      <DCClientRange>
        <ClientRangeID>1</ClientRangeID>
        <ClientID>2</ClientID>
        <Name>sample string 3</Name>
        <StartIP>sample string 4</StartIP>
        <EndIP>sample string 5</EndIP>
        <State>sample string 6</State>
        <IsEnabled>true</IsEnabled>
        <Community>sample string 8</Community>
        <NumOfDevices>1</NumOfDevices>
        <Created>2018-10-20T01:43:53.8165708+00:00</Created>
        <Comment>sample string 10</Comment>
        <Exclude>true</Exclude>
      </DCClientRange>
    </Ranges>
  </DCClient>
  <DCClient>
    <ClientID>1</ClientID>
    <AccountID>2</AccountID>
    <Name>sample string 3</Name>
    <Created>2018-10-20T01:43:53.8165708+00:00</Created>
    <LastDiscovered>2018-10-20T01:43:53.8165708+00:00</LastDiscovered>
    <LastCollect>2018-10-20T01:43:53.8165708+00:00</LastCollect>
    <LastActivity>2018-10-20T01:43:53.8165708+00:00</LastActivity>
    <IPv4>sample string 9</IPv4>
    <Version>sample string 10</Version>
    <IsActivated>true</IsActivated>
    <IsInUse>true</IsInUse>
    <Ranges>
      <DCClientRange>
        <ClientRangeID>1</ClientRangeID>
        <ClientID>2</ClientID>
        <Name>sample string 3</Name>
        <StartIP>sample string 4</StartIP>
        <EndIP>sample string 5</EndIP>
        <State>sample string 6</State>
        <IsEnabled>true</IsEnabled>
        <Community>sample string 8</Community>
        <NumOfDevices>1</NumOfDevices>
        <Created>2018-10-20T01:43:53.8165708+00:00</Created>
        <Comment>sample string 10</Comment>
        <Exclude>true</Exclude>
      </DCClientRange>
      <DCClientRange>
        <ClientRangeID>1</ClientRangeID>
        <ClientID>2</ClientID>
        <Name>sample string 3</Name>
        <StartIP>sample string 4</StartIP>
        <EndIP>sample string 5</EndIP>
        <State>sample string 6</State>
        <IsEnabled>true</IsEnabled>
        <Community>sample string 8</Community>
        <NumOfDevices>1</NumOfDevices>
        <Created>2018-10-20T01:43:53.8165708+00:00</Created>
        <Comment>sample string 10</Comment>
        <Exclude>true</Exclude>
      </DCClientRange>
    </Ranges>
  </DCClient>
</ArrayOfDCClient>