Data Service

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

More information: https://helloreverb.com

Contact Info: [email protected]

Version: v1

http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

Models

Computer

get /api/v1/hardware/computers/{computerId}/drives/{driveId}

Get one drive for a computer (getADriveForComputer)

Path parameters

computerId (required)

Path Parameter — Computer Id format: int32

driveId (required)

Path Parameter — Drive Id format: int32

Query parameters

page (optional)

Query Parameter — The 1-based page number of the paged results to return

pageSize (optional)

Query Parameter — The number of records in each page

sort (optional)

Query Parameter — The column names and directions for sorting the results

filter (optional)

Query Parameter — A record-selection specification

fields (optional)

Query Parameter — The column names of the fields to return

Return type

DriveDto

Example data

Content-Type: application/json

{
  "computerId" : 9,
  "deviceType" : "deviceType",
  "mountPoint" : "mountPoint",
  "driveId" : 9,
  "percentUsed" : 8.762042012749001,
  "deviceName" : "deviceName",
  "volumeSize" : 6,
  "fileSystemType" : "fileSystemType"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Success DriveDto

400

Bad Request String

404

Not Found String

500

Server Error

401

Unauthorized

get /api/v1/hardware/computers/services/{serviceId}

Get list of services by their identifier (getAServiceForAllComputers)

Path parameters

serviceId (required)

Path Parameter — Service Id format: int32

Query parameters

page (optional)

Query Parameter — The 1-based page number of the paged results to return

pageSize (optional)

Query Parameter — The number of records in each page

sort (optional)

Query Parameter — The column names and directions for sorting the results

filter (optional)

Query Parameter — A record-selection specification

fields (optional)

Query Parameter — The column names of the fields to return

Return type

ServiceDto

Example data

Content-Type: application/json

{
  "computerId" : 9,
  "isRunning" : true,
  "displayName" : "displayName",
  "startMode" : "startMode",
  "name" : "name",
  "state" : "state",
  "serviceId" : 6,
  "command" : "command"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Success ServiceDto

400

Bad Request String

404

Not Found String

500

Server Error

401

Unauthorized

get /api/v1/hardware/computers/{computerId}/services/{serviceId}

Get one service for a computer (getAServiceForComputer)

Path parameters

computerId (required)

Path Parameter — Computer Id format: int32

serviceId (required)

Path Parameter — Service Id format: int32

Query parameters

page (optional)

Query Parameter — The 1-based page number of the paged results to return

pageSize (optional)

Query Parameter — The number of records in each page

sort (optional)

Query Parameter — The column names and directions for sorting the results

filter (optional)

Query Parameter — A record-selection specification

fields (optional)

Query Parameter — The column names of the fields to return

Return type

ServiceDto

Example data

Content-Type: application/json

{
  "computerId" : 9,
  "isRunning" : true,
  "displayName" : "displayName",
  "startMode" : "startMode",
  "name" : "name",
  "state" : "state",
  "serviceId" : 6,
  "command" : "command"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Success ServiceDto

400

Bad Request String

404

Not Found String

500

Server Error

401

Unauthorized

get /api/v1/hardware/computers/camagents

Get a list of cam agents (getCamAgentsForAllComputers)

Query parameters

page (optional)

Query Parameter — The 1-based page number of the paged results to return

pageSize (optional)

Query Parameter — The number of records in each page

sort (optional)

Query Parameter — The column names and directions for sorting the results

filter (optional)

Query Parameter — A record-selection specification

fields (optional)

Query Parameter — The column names of the fields to return

Return type

array[CamAgentDto]

Example data

Content-Type: application/json

[ {
  "computerId" : 1,
  "isDecommissioned" : true,
  "installState" : 1,
  "accessPointAddress" : "accessPointAddress",
  "lastHeartbeat" : "2000-01-23T04:56:07.000+00:00",
  "installDate" : "2000-01-23T04:56:07.000+00:00",
  "isInventoryManaged" : true,
  "agentVersion" : "agentVersion",
  "nextInventory" : "2000-01-23T04:56:07.000+00:00",
  "lastInventory" : "2000-01-23T04:56:07.000+00:00",
  "isMeterManaged" : true,
  "installStateString" : "installStateString"
}, {
  "computerId" : 1,
  "isDecommissioned" : true,
  "installState" : 1,
  "accessPointAddress" : "accessPointAddress",
  "lastHeartbeat" : "2000-01-23T04:56:07.000+00:00",
  "installDate" : "2000-01-23T04:56:07.000+00:00",
  "isInventoryManaged" : true,
  "agentVersion" : "agentVersion",
  "nextInventory" : "2000-01-23T04:56:07.000+00:00",
  "lastInventory" : "2000-01-23T04:56:07.000+00:00",
  "isMeterManaged" : true,
  "installStateString" : "installStateString"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Success

400

Bad Request String

404

Not Found String

500

Server Error

401

Unauthorized

get /api/v1/hardware/computers/{id}/camagents

Get a list of cam agents for a computer (getCamAgentsForComputer)

There exists one cam agent in CAM DB so this will only return one item

Path parameters

id (required)

Path Parameter — Computer Id format: int32

Query parameters

page (optional)

Query Parameter — The 1-based page number of the paged results to return

pageSize (optional)

Query Parameter — The number of records in each page

sort (optional)

Query Parameter — The column names and directions for sorting the results

filter (optional)

Query Parameter — A record-selection specification

fields (optional)

Query Parameter — The column names of the fields to return

Return type

array[CamAgentDto]

Example data

Content-Type: application/json

[ {
  "computerId" : 1,
  "isDecommissioned" : true,
  "installState" : 1,
  "accessPointAddress" : "accessPointAddress",
  "lastHeartbeat" : "2000-01-23T04:56:07.000+00:00",
  "installDate" : "2000-01-23T04:56:07.000+00:00",
  "isInventoryManaged" : true,
  "agentVersion" : "agentVersion",
  "nextInventory" : "2000-01-23T04:56:07.000+00:00",
  "lastInventory" : "2000-01-23T04:56:07.000+00:00",
  "isMeterManaged" : true,
  "installStateString" : "installStateString"
}, {
  "computerId" : 1,
  "isDecommissioned" : true,
  "installState" : 1,
  "accessPointAddress" : "accessPointAddress",
  "lastHeartbeat" : "2000-01-23T04:56:07.000+00:00",
  "installDate" : "2000-01-23T04:56:07.000+00:00",
  "isInventoryManaged" : true,
  "agentVersion" : "agentVersion",
  "nextInventory" : "2000-01-23T04:56:07.000+00:00",
  "lastInventory" : "2000-01-23T04:56:07.000+00:00",
  "isMeterManaged" : true,
  "installStateString" : "installStateString"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Success

400

Bad Request String

404

Not Found String

500

Server Error

401

Unauthorized

get /api/v1/hardware/computers/{id}

Get one computer by its identifier (getComputer)

Path parameters

id (required)

Path Parameter — Computer Id format: int32

Return type

ComputerDetailDto

Example data

Content-Type: application/json

{
  "videoControllers" : [ {
    "computerId" : 6,
    "controller" : "controller",
    "alternateMode" : "alternateMode",
    "horizontalResolution" : 7,
    "videoRam" : 5,
    "verticalResolution" : 1,
    "bitsPerPixel" : 4,
    "currentMode" : "currentMode",
    "directXMode" : "directXMode"
  }, {
    "computerId" : 6,
    "controller" : "controller",
    "alternateMode" : "alternateMode",
    "horizontalResolution" : 7,
    "videoRam" : 5,
    "verticalResolution" : 1,
    "bitsPerPixel" : 4,
    "currentMode" : "currentMode",
    "directXMode" : "directXMode"
  } ],
  "computer" : {
    "lastUserName" : "lastUserName",
    "dontCare" : true,
    "virtualization" : "virtualization",
    "isInventoryManaged" : true,
    "vmPlatformName" : "vmPlatformName",
    "isMeterManaged" : true,
    "chassis" : "chassis",
    "lastUserId" : 1,
    "computerId" : 0,
    "isCamAgentInstalled" : true,
    "osPlatformName" : "osPlatformName",
    "primaryIpAddress" : "primaryIpAddress",
    "domainName" : "domainName",
    "name" : "name",
    "softwareInstallations" : 6
  },
  "memory" : {
    "computerId" : 9,
    "size" : 3,
    "slotsAvailable" : 2,
    "slotsInUse" : 4
  },
  "camAgent" : {
    "computerId" : 1,
    "isDecommissioned" : true,
    "installState" : 1,
    "accessPointAddress" : "accessPointAddress",
    "lastHeartbeat" : "2000-01-23T04:56:07.000+00:00",
    "installDate" : "2000-01-23T04:56:07.000+00:00",
    "isInventoryManaged" : true,
    "agentVersion" : "agentVersion",
    "nextInventory" : "2000-01-23T04:56:07.000+00:00",
    "lastInventory" : "2000-01-23T04:56:07.000+00:00",
    "isMeterManaged" : true,
    "installStateString" : "installStateString"
  },
  "drives" : [ {
    "computerId" : 9,
    "deviceType" : "deviceType",
    "mountPoint" : "mountPoint",
    "driveId" : 9,
    "percentUsed" : 8.762042012749001,
    "deviceName" : "deviceName",
    "volumeSize" : 6,
    "fileSystemType" : "fileSystemType"
  }, {
    "computerId" : 9,
    "deviceType" : "deviceType",
    "mountPoint" : "mountPoint",
    "driveId" : 9,
    "percentUsed" : 8.762042012749001,
    "deviceName" : "deviceName",
    "volumeSize" : 6,
    "fileSystemType" : "fileSystemType"
  } ],
  "systemInformation" : {
    "enclosureName" : "enclosureName",
    "biosVersion" : "biosVersion",
    "manufacturerName" : "manufacturerName",
    "primaryHdSerialNumber" : 6,
    "chassis" : "chassis",
    "primaryNicAddress" : "primaryNicAddress",
    "biosSerialNumber" : "biosSerialNumber",
    "productName" : "productName",
    "computerId" : 0,
    "modelName" : "modelName",
    "biosName" : "biosName",
    "smsId" : "smsId",
    "systemSerialNumber" : "systemSerialNumber",
    "primaryIpAddress" : "primaryIpAddress",
    "biosDate" : "biosDate"
  },
  "groups" : [ {
    "computerGroupId" : 1,
    "path" : "path",
    "name" : "name"
  }, {
    "computerGroupId" : 1,
    "path" : "path",
    "name" : "name"
  } ],
  "services" : [ {
    "computerId" : 9,
    "isRunning" : true,
    "displayName" : "displayName",
    "startMode" : "startMode",
    "name" : "name",
    "state" : "state",
    "serviceId" : 6,
    "command" : "command"
  }, {
    "computerId" : 9,
    "isRunning" : true,
    "displayName" : "displayName",
    "startMode" : "startMode",
    "name" : "name",
    "state" : "state",
    "serviceId" : 6,
    "command" : "command"
  } ],
  "processor" : {
    "computerId" : 1,
    "logicalProcessors" : 5,
    "identification" : "identification",
    "cores" : 2,
    "processors" : 5,
    "speed" : 7
  },
  "platform" : {
    "computerId" : 7,
    "osVersion" : "osVersion",
    "osLocale" : "osLocale",
    "virtualization" : "virtualization",
    "vmPlatformName" : "vmPlatformName",
    "name" : "name",
    "osServicePack" : "osServicePack",
    "osManufacturer" : "osManufacturer",
    "osTimeZone" : "osTimeZone",
    "operatingSystem" : "operatingSystem"
  }
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Success ComputerDetailDto

400

Bad Request String

404

Not Found String

500

Server Error

401

Unauthorized

get /api/v1/hardware/computers/{id}/vmguests

Get a list of VM Guests for a computer (getComputerVmGuests)

Path parameters

id (required)

Path Parameter — Computer Id format: int32

Query parameters

page (optional)

Query Parameter — The 1-based page number of the paged results to return

pageSize (optional)

Query Parameter — The number of records in each page

sort (optional)

Query Parameter — The column names and directions for sorting the results

filter (optional)

Query Parameter — A record-selection specification

fields (optional)

Query Parameter — The column names of the fields to return

Return type

array[ComputerDto]

Example data

Content-Type: application/json

[ {
  "lastUserName" : "lastUserName",
  "dontCare" : true,
  "virtualization" : "virtualization",
  "isInventoryManaged" : true,
  "vmPlatformName" : "vmPlatformName",
  "isMeterManaged" : true,
  "chassis" : "chassis",
  "lastUserId" : 1,
  "computerId" : 0,
  "isCamAgentInstalled" : true,
  "osPlatformName" : "osPlatformName",
  "primaryIpAddress" : "primaryIpAddress",
  "domainName" : "domainName",
  "name" : "name",
  "softwareInstallations" : 6
}, {
  "lastUserName" : "lastUserName",
  "dontCare" : true,
  "virtualization" : "virtualization",
  "isInventoryManaged" : true,
  "vmPlatformName" : "vmPlatformName",
  "isMeterManaged" : true,
  "chassis" : "chassis",
  "lastUserId" : 1,
  "computerId" : 0,
  "isCamAgentInstalled" : true,
  "osPlatformName" : "osPlatformName",
  "primaryIpAddress" : "primaryIpAddress",
  "domainName" : "domainName",
  "name" : "name",
  "softwareInstallations" : 6
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Success

400

Bad Request String

404

Not Found String

500

Server Error

401

Unauthorized

get /api/v1/hardware/computers/{id}/vmhost

Get one computer's VM Host (getComputerVmHost)

Path parameters

id (required)

Path Parameter — Computer Id format: int32

Query parameters

fields (optional)

Query Parameter — The column names of the fields to return

Return type

ComputerDto

Example data

Content-Type: application/json

{
  "lastUserName" : "lastUserName",
  "dontCare" : true,
  "virtualization" : "virtualization",
  "isInventoryManaged" : true,
  "vmPlatformName" : "vmPlatformName",
  "isMeterManaged" : true,
  "chassis" : "chassis",
  "lastUserId" : 1,
  "computerId" : 0,
  "isCamAgentInstalled" : true,
  "osPlatformName" : "osPlatformName",
  "primaryIpAddress" : "primaryIpAddress",
  "domainName" : "domainName",
  "name" : "name",
  "softwareInstallations" : 6
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Success ComputerDto

400

Bad Request String

404

Not Found String

500

Server Error

401

Unauthorized

get /api/v1/hardware/computers

Get a list of computers (getComputers)

Query parameters

page (optional)

Query Parameter — The 1-based page number of the paged results to return

pageSize (optional)

Query Parameter — The number of records in each page

sort (optional)

Query Parameter — The column names and directions for sorting the results

filter (optional)

Query Parameter — A record-selection specification

fields (optional)

Query Parameter — The column names of the fields to return

Return type

array[ComputerDto]

Example data

Content-Type: application/json

[ {
  "lastUserName" : "lastUserName",
  "dontCare" : true,
  "virtualization" : "virtualization",
  "isInventoryManaged" : true,
  "vmPlatformName" : "vmPlatformName",
  "isMeterManaged" : true,
  "chassis" : "chassis",
  "lastUserId" : 1,
  "computerId" : 0,
  "isCamAgentInstalled" : true,
  "osPlatformName" : "osPlatformName",
  "primaryIpAddress" : "primaryIpAddress",
  "domainName" : "domainName",
  "name" : "name",
  "softwareInstallations" : 6
}, {
  "lastUserName" : "lastUserName",
  "dontCare" : true,
  "virtualization" : "virtualization",
  "isInventoryManaged" : true,
  "vmPlatformName" : "vmPlatformName",
  "isMeterManaged" : true,
  "chassis" : "chassis",
  "lastUserId" : 1,
  "computerId" : 0,
  "isCamAgentInstalled" : true,
  "osPlatformName" : "osPlatformName",
  "primaryIpAddress" : "primaryIpAddress",
  "domainName" : "domainName",
  "name" : "name",
  "softwareInstallations" : 6
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Success

400

Bad Request String

404

Not Found String

500

Server Error

401

Unauthorized

get /api/v1/hardware/computers/drives

Get a list of drives (getDrivesForAllComputers)

Query parameters

page (optional)

Query Parameter — The 1-based page number of the paged results to return

pageSize (optional)

Query Parameter — The number of records in each page

sort (optional)

Query Parameter — The column names and directions for sorting the results

filter (optional)

Query Parameter — A record-selection specification

fields (optional)

Query Parameter — The column names of the fields to return

Return type

array[DriveDto]

Example data

Content-Type: application/json

[ {
  "computerId" : 9,
  "deviceType" : "deviceType",
  "mountPoint" : "mountPoint",
  "driveId" : 9,
  "percentUsed" : 8.762042012749001,
  "deviceName" : "deviceName",
  "volumeSize" : 6,
  "fileSystemType" : "fileSystemType"
}, {
  "computerId" : 9,
  "deviceType" : "deviceType",
  "mountPoint" : "mountPoint",
  "driveId" : 9,
  "percentUsed" : 8.762042012749001,
  "deviceName" : "deviceName",
  "volumeSize" : 6,
  "fileSystemType" : "fileSystemType"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Success

400

Bad Request String

404

Not Found String

500

Server Error

401

Unauthorized

get /api/v1/hardware/computers/{id}/drives

Get a list of drives for a computer (getDrivesForComputer)

Path parameters

id (required)

Path Parameter — Computer Id format: int32

Query parameters

page (optional)

Query Parameter — The 1-based page number of the paged results to return

pageSize (optional)

Query Parameter — The number of records in each page

sort (optional)

Query Parameter — The column names and directions for sorting the results

filter (optional)

Query Parameter — A record-selection specification

fields (optional)

Query Parameter — The column names of the fields to return

Return type

array[DriveDto]

Example data

Content-Type: application/json

[ {
  "computerId" : 9,
  "deviceType" : "deviceType",
  "mountPoint" : "mountPoint",
  "driveId" : 9,
  "percentUsed" : 8.762042012749001,
  "deviceName" : "deviceName",
  "volumeSize" : 6,
  "fileSystemType" : "fileSystemType"
}, {
  "computerId" : 9,
  "deviceType" : "deviceType",
  "mountPoint" : "mountPoint",
  "driveId" : 9,
  "percentUsed" : 8.762042012749001,
  "deviceName" : "deviceName",
  "volumeSize" : 6,
  "fileSystemType" : "fileSystemType"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Success

400

Bad Request String

404

Not Found String

500

Server Error

401

Unauthorized

get /api/v1/hardware/computers/memory

Get a list of memory objects (getMemoryForAllComputers)

Query parameters

page (optional)

Query Parameter — The 1-based page number of the paged results to return

pageSize (optional)

Query Parameter — The number of records in each page

sort (optional)

Query Parameter — The column names and directions for sorting the results

filter (optional)

Query Parameter — A record-selection specification

fields (optional)

Query Parameter — The column names of the fields to return

Return type

array[MemoryDto]

Example data

Content-Type: application/json

[ {
  "computerId" : 9,
  "size" : 3,
  "slotsAvailable" : 2,
  "slotsInUse" : 4
}, {
  "computerId" : 9,
  "size" : 3,
  "slotsAvailable" : 2,
  "slotsInUse" : 4
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Success

400

Bad Request String

404

Not Found String

500

Server Error

401

Unauthorized

get /api/v1/hardware/computers/{id}/memory

Get memory for a computer (getMemoryForComputer)

Path parameters

id (required)

Path Parameter — ComputerId format: int32

Query parameters

fields (optional)

Query Parameter — The column names of the fields to return

Return type

MemoryDto

Example data

Content-Type: application/json

{
  "computerId" : 9,
  "size" : 3,
  "slotsAvailable" : 2,
  "slotsInUse" : 4
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Success MemoryDto

400

Bad Request String

404

Not Found String

500

Server Error

401

Unauthorized

get /api/v1/hardware/computers/{computerId}/networkadapters/{adapterId}

Get one network adapter for a computer (getNetworkAdapterForComputer)

Path parameters

computerId (required)

Path Parameter — Computer Id format: int32

adapterId (required)

Path Parameter — Network Adapter Id format: int32

Query parameters

fields (optional)

Query Parameter — The column names of the fields to return

Return type

NetworkAdapterDto

Example data

Content-Type: application/json

{
  "gateways" : [ "gateways", "gateways" ],
  "winsSecondary" : "winsSecondary",
  "dhcpServer" : "dhcpServer",
  "autoConfigureEnabled" : true,
  "ipAddress" : "ipAddress",
  "description" : "description",
  "subnetMask" : "subnetMask",
  "adapterType" : "adapterType",
  "dhcpLeaseExpires" : "2000-01-23T04:56:07.000+00:00",
  "computerId" : 0,
  "macAddress" : "macAddress",
  "dnsSuffix" : "dnsSuffix",
  "dhcpLeaseObtained" : "2000-01-23T04:56:07.000+00:00",
  "name" : "name",
  "mediaDisconnected" : true,
  "winsPrimary" : "winsPrimary",
  "adapterId" : 6,
  "dnsServers" : [ "dnsServers", "dnsServers" ],
  "dhcpEnabled" : true
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Success NetworkAdapterDto

400

Bad Request String

404

Not Found String

500

Server Error

401

Unauthorized

get /api/v1/hardware/computers/networkadapters

Get a list of network adapters (getNetworkAdaptersForAllComputers)

Query parameters

page (optional)

Query Parameter — The 1-based page number of the paged results to return

pageSize (optional)

Query Parameter — The number of records in each page

sort (optional)

Query Parameter — The column names and directions for sorting the results

filter (optional)

Query Parameter — A record-selection specification

fields (optional)

Query Parameter — The column names of the fields to return

Return type

array[NetworkAdapterDto]

Example data

Content-Type: application/json

[ {
  "gateways" : [ "gateways", "gateways" ],
  "winsSecondary" : "winsSecondary",
  "dhcpServer" : "dhcpServer",
  "autoConfigureEnabled" : true,
  "ipAddress" : "ipAddress",
  "description" : "description",
  "subnetMask" : "subnetMask",
  "adapterType" : "adapterType",
  "dhcpLeaseExpires" : "2000-01-23T04:56:07.000+00:00",
  "computerId" : 0,
  "macAddress" : "macAddress",
  "dnsSuffix" : "dnsSuffix",
  "dhcpLeaseObtained" : "2000-01-23T04:56:07.000+00:00",
  "name" : "name",
  "mediaDisconnected" : true,
  "winsPrimary" : "winsPrimary",
  "adapterId" : 6,
  "dnsServers" : [ "dnsServers", "dnsServers" ],
  "dhcpEnabled" : true
}, {
  "gateways" : [ "gateways", "gateways" ],
  "winsSecondary" : "winsSecondary",
  "dhcpServer" : "dhcpServer",
  "autoConfigureEnabled" : true,
  "ipAddress" : "ipAddress",
  "description" : "description",
  "subnetMask" : "subnetMask",
  "adapterType" : "adapterType",
  "dhcpLeaseExpires" : "2000-01-23T04:56:07.000+00:00",
  "computerId" : 0,
  "macAddress" : "macAddress",
  "dnsSuffix" : "dnsSuffix",
  "dhcpLeaseObtained" : "2000-01-23T04:56:07.000+00:00",
  "name" : "name",
  "mediaDisconnected" : true,
  "winsPrimary" : "winsPrimary",
  "adapterId" : 6,
  "dnsServers" : [ "dnsServers", "dnsServers" ],
  "dhcpEnabled" : true
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Success

400

Bad Request String

404

Not Found String

500

Server Error

401

Unauthorized

get /api/v1/hardware/computers/{id}/networkadapters

Get a list of network adapters for a computer (getNetworkAdaptersForComputer)

Path parameters

id (required)

Path Parameter — Computer Id format: int32

Query parameters

page (optional)

Query Parameter — The 1-based page number of the paged results to return

pageSize (optional)

Query Parameter — The number of records in each page

sort (optional)

Query Parameter — The column names and directions for sorting the results

filter (optional)

Query Parameter — A record-selection specification

fields (optional)

Query Parameter — The column names of the fields to return

Return type

array[NetworkAdapterDto]

Example data

Content-Type: application/json

[ {
  "gateways" : [ "gateways", "gateways" ],
  "winsSecondary" : "winsSecondary",
  "dhcpServer" : "dhcpServer",
  "autoConfigureEnabled" : true,
  "ipAddress" : "ipAddress",
  "description" : "description",
  "subnetMask" : "subnetMask",
  "adapterType" : "adapterType",
  "dhcpLeaseExpires" : "2000-01-23T04:56:07.000+00:00",
  "computerId" : 0,
  "macAddress" : "macAddress",
  "dnsSuffix" : "dnsSuffix",
  "dhcpLeaseObtained" : "2000-01-23T04:56:07.000+00:00",
  "name" : "name",
  "mediaDisconnected" : true,
  "winsPrimary" : "winsPrimary",
  "adapterId" : 6,
  "dnsServers" : [ "dnsServers", "dnsServers" ],
  "dhcpEnabled" : true
}, {
  "gateways" : [ "gateways", "gateways" ],
  "winsSecondary" : "winsSecondary",
  "dhcpServer" : "dhcpServer",
  "autoConfigureEnabled" : true,
  "ipAddress" : "ipAddress",
  "description" : "description",
  "subnetMask" : "subnetMask",
  "adapterType" : "adapterType",
  "dhcpLeaseExpires" : "2000-01-23T04:56:07.000+00:00",
  "computerId" : 0,
  "macAddress" : "macAddress",
  "dnsSuffix" : "dnsSuffix",
  "dhcpLeaseObtained" : "2000-01-23T04:56:07.000+00:00",
  "name" : "name",
  "mediaDisconnected" : true,
  "winsPrimary" : "winsPrimary",
  "adapterId" : 6,
  "dnsServers" : [ "dnsServers", "dnsServers" ],
  "dhcpEnabled" : true
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Success

400

Bad Request String

404

Not Found String

500

Server Error

401

Unauthorized

get /api/v1/hardware/computers/platform

Get a list of platforms (getPlatformForAllComputers)

Query parameters

page (optional)

Query Parameter — The 1-based page number of the paged results to return

pageSize (optional)

Query Parameter — The number of records in each page

sort (optional)

Query Parameter — The column names and directions for sorting the results

filter (optional)

Query Parameter — A record-selection specification

fields (optional)

Query Parameter — The column names of the fields to return

Return type

array[PlatformDto]

Example data

Content-Type: application/json

[ {
  "computerId" : 7,
  "osVersion" : "osVersion",
  "osLocale" : "osLocale",
  "virtualization" : "virtualization",
  "vmPlatformName" : "vmPlatformName",
  "name" : "name",
  "osServicePack" : "osServicePack",
  "osManufacturer" : "osManufacturer",
  "osTimeZone" : "osTimeZone",
  "operatingSystem" : "operatingSystem"
}, {
  "computerId" : 7,
  "osVersion" : "osVersion",
  "osLocale" : "osLocale",
  "virtualization" : "virtualization",
  "vmPlatformName" : "vmPlatformName",
  "name" : "name",
  "osServicePack" : "osServicePack",
  "osManufacturer" : "osManufacturer",
  "osTimeZone" : "osTimeZone",
  "operatingSystem" : "operatingSystem"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Success

400

Bad Request String

404

Not Found String

500

Server Error

401

Unauthorized

get /api/v1/hardware/computers/{id}/platform

Get platform for a computer (getPlatformForComputer)

There exists one platform in CAM DB so this will only return one item

Path parameters

id (required)

Path Parameter — Computer Id format: int32

Query parameters

fields (optional)

Query Parameter — The column names of the fields to return

Return type

array[PlatformDto]

Example data

Content-Type: application/json

[ {
  "computerId" : 7,
  "osVersion" : "osVersion",
  "osLocale" : "osLocale",
  "virtualization" : "virtualization",
  "vmPlatformName" : "vmPlatformName",
  "name" : "name",
  "osServicePack" : "osServicePack",
  "osManufacturer" : "osManufacturer",
  "osTimeZone" : "osTimeZone",
  "operatingSystem" : "operatingSystem"
}, {
  "computerId" : 7,
  "osVersion" : "osVersion",
  "osLocale" : "osLocale",
  "virtualization" : "virtualization",
  "vmPlatformName" : "vmPlatformName",
  "name" : "name",
  "osServicePack" : "osServicePack",
  "osManufacturer" : "osManufacturer",
  "osTimeZone" : "osTimeZone",
  "operatingSystem" : "operatingSystem"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Success

400

Bad Request String

404

Not Found String

500

Server Error

401

Unauthorized

get /api/v1/hardware/computers/processors

Get a list of processors (getProcessorsForAllComputers)

Query parameters

page (optional)

Query Parameter — The 1-based page number of the paged results to return

pageSize (optional)

Query Parameter — The number of records in each page

sort (optional)

Query Parameter — The column names and directions for sorting the results

filter (optional)

Query Parameter — A record-selection specification

fields (optional)

Query Parameter — The column names of the fields to return

Return type

array[ProcessorDto]

Example data

Content-Type: application/json

[ {
  "computerId" : 1,
  "logicalProcessors" : 5,
  "identification" : "identification",
  "cores" : 2,
  "processors" : 5,
  "speed" : 7
}, {
  "computerId" : 1,
  "logicalProcessors" : 5,
  "identification" : "identification",
  "cores" : 2,
  "processors" : 5,
  "speed" : 7
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Success

400

Bad Request String

404

Not Found String

500

Server Error

401

Unauthorized

get /api/v1/hardware/computers/{id}/processors

Get processor(s) for a computer (getProcessorsForComputer)

Path parameters

id (required)

Path Parameter — ComputerId format: int32

Query parameters

fields (optional)

Query Parameter — The column names of the fields to return

Return type

ProcessorDto

Example data

Content-Type: application/json

{
  "computerId" : 1,
  "logicalProcessors" : 5,
  "identification" : "identification",
  "cores" : 2,
  "processors" : 5,
  "speed" : 7
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Success ProcessorDto

400

Bad Request String

404

Not Found String

500

Server Error

401

Unauthorized

get /api/v1/hardware/computers/services

Get a list of services (getServicesForAllComputers)

Query parameters

page (optional)

Query Parameter — The 1-based page number of the paged results to return

pageSize (optional)

Query Parameter — The number of records in each page

sort (optional)

Query Parameter — The column names and directions for sorting the results

filter (optional)

Query Parameter — A record-selection specification

fields (optional)

Query Parameter — The column names of the fields to return

Return type

array[ServiceDto]

Example data

Content-Type: application/json

[ {
  "computerId" : 9,
  "isRunning" : true,
  "displayName" : "displayName",
  "startMode" : "startMode",
  "name" : "name",
  "state" : "state",
  "serviceId" : 6,
  "command" : "command"
}, {
  "computerId" : 9,
  "isRunning" : true,
  "displayName" : "displayName",
  "startMode" : "startMode",
  "name" : "name",
  "state" : "state",
  "serviceId" : 6,
  "command" : "command"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Success

400

Bad Request String

404

Not Found String

500

Server Error

401

Unauthorized

get /api/v1/hardware/computers/{id}/services

Get a list of services for a computer (getServicesForComputer)

Path parameters

id (required)

Path Parameter — Computer Id format: int32

Query parameters

page (optional)

Query Parameter — The 1-based page number of the paged results to return

pageSize (optional)

Query Parameter — The number of records in each page

sort (optional)

Query Parameter — The column names and directions for sorting the results

filter (optional)

Query Parameter — A record-selection specification

fields (optional)

Query Parameter — The column names of the fields to return

Return type

array[ServiceDto]

Example data

Content-Type: application/json

[ {
  "computerId" : 9,
  "isRunning" : true,
  "displayName" : "displayName",
  "startMode" : "startMode",
  "name" : "name",
  "state" : "state",
  "serviceId" : 6,
  "command" : "command"
}, {
  "computerId" : 9,
  "isRunning" : true,
  "displayName" : "displayName",
  "startMode" : "startMode",
  "name" : "name",
  "state" : "state",
  "serviceId" : 6,
  "command" : "command"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Success

400

Bad Request String

404

Not Found String

500

Server Error

401

Unauthorized

get /api/v1/hardware/computers/systeminformation

Get a list of system information objects (getSystemInformationForAllComputers)

Query parameters

page (optional)

Query Parameter — The 1-based page number of the paged results to return

pageSize (optional)

Query Parameter — The number of records in each page

sort (optional)

Query Parameter — The column names and directions for sorting the results

filter (optional)

Query Parameter — A record-selection specification

fields (optional)

Query Parameter — The column names of the fields to return

Return type

array[SystemInformationDto]

Example data

Content-Type: application/json

[ {
  "enclosureName" : "enclosureName",
  "biosVersion" : "biosVersion",
  "manufacturerName" : "manufacturerName",
  "primaryHdSerialNumber" : 6,
  "chassis" : "chassis",
  "primaryNicAddress" : "primaryNicAddress",
  "biosSerialNumber" : "biosSerialNumber",
  "productName" : "productName",
  "computerId" : 0,
  "modelName" : "modelName",
  "biosName" : "biosName",
  "smsId" : "smsId",
  "systemSerialNumber" : "systemSerialNumber",
  "primaryIpAddress" : "primaryIpAddress",
  "biosDate" : "biosDate"
}, {
  "enclosureName" : "enclosureName",
  "biosVersion" : "biosVersion",
  "manufacturerName" : "manufacturerName",
  "primaryHdSerialNumber" : 6,
  "chassis" : "chassis",
  "primaryNicAddress" : "primaryNicAddress",
  "biosSerialNumber" : "biosSerialNumber",
  "productName" : "productName",
  "computerId" : 0,
  "modelName" : "modelName",
  "biosName" : "biosName",
  "smsId" : "smsId",
  "systemSerialNumber" : "systemSerialNumber",
  "primaryIpAddress" : "primaryIpAddress",
  "biosDate" : "biosDate"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Success

400

Bad Request String

404

Not Found String

500

Server Error

401

Unauthorized

get /api/v1/hardware/computers/{id}/systeminformation

Get system information a computer (getSystemInformationForComputer)

Path parameters

id (required)

Path Parameter — format: int32

Query parameters

fields (optional)

Query Parameter — The column names of the fields to return

Return type

array[SystemInformationDto]

Example data

Content-Type: application/json

[ {
  "enclosureName" : "enclosureName",
  "biosVersion" : "biosVersion",
  "manufacturerName" : "manufacturerName",
  "primaryHdSerialNumber" : 6,
  "chassis" : "chassis",
  "primaryNicAddress" : "primaryNicAddress",
  "biosSerialNumber" : "biosSerialNumber",
  "productName" : "productName",
  "computerId" : 0,
  "modelName" : "modelName",
  "biosName" : "biosName",
  "smsId" : "smsId",
  "systemSerialNumber" : "systemSerialNumber",
  "primaryIpAddress" : "primaryIpAddress",
  "biosDate" : "biosDate"
}, {
  "enclosureName" : "enclosureName",
  "biosVersion" : "biosVersion",
  "manufacturerName" : "manufacturerName",
  "primaryHdSerialNumber" : 6,
  "chassis" : "chassis",
  "primaryNicAddress" : "primaryNicAddress",
  "biosSerialNumber" : "biosSerialNumber",
  "productName" : "productName",
  "computerId" : 0,
  "modelName" : "modelName",
  "biosName" : "biosName",
  "smsId" : "smsId",
  "systemSerialNumber" : "systemSerialNumber",
  "primaryIpAddress" : "primaryIpAddress",
  "biosDate" : "biosDate"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Success

400

Bad Request String

404

Not Found String

500

Server Error

401

Unauthorized

get /api/v1/hardware/computers/videocontrollers

Get a list of video controllers (getVideoControllerForAllComputers)

Query parameters

page (optional)

Query Parameter — The 1-based page number of the paged results to return

pageSize (optional)

Query Parameter — The number of records in each page

sort (optional)

Query Parameter — The column names and directions for sorting the results

filter (optional)

Query Parameter — A record-selection specification

fields (optional)

Query Parameter — The column names of the fields to return

Return type

array[VideoControllerDto]

Example data

Content-Type: application/json

[ {
  "computerId" : 6,
  "controller" : "controller",
  "alternateMode" : "alternateMode",
  "horizontalResolution" : 7,
  "videoRam" : 5,
  "verticalResolution" : 1,
  "bitsPerPixel" : 4,
  "currentMode" : "currentMode",
  "directXMode" : "directXMode"
}, {
  "computerId" : 6,
  "controller" : "controller",
  "alternateMode" : "alternateMode",
  "horizontalResolution" : 7,
  "videoRam" : 5,
  "verticalResolution" : 1,
  "bitsPerPixel" : 4,
  "currentMode" : "currentMode",
  "directXMode" : "directXMode"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Success

400

Bad Request String

404

Not Found String

500

Server Error

401

Unauthorized

get /api/v1/hardware/computers/{id}/videocontrollers

Get a list of video controllers for a computer (getVideoControllersForComputer)

Path parameters

id (required)

Path Parameter — Computer Id format: int32

Query parameters

page (optional)

Query Parameter — The 1-based page number of the paged results to return

pageSize (optional)

Query Parameter — The number of records in each page

sort (optional)

Query Parameter — The column names and directions for sorting the results

filter (optional)

Query Parameter — A record-selection specification

fields (optional)

Query Parameter — The column names of the fields to return

Return type

array[VideoControllerDto]

Example data

Content-Type: application/json

[ {
  "computerId" : 6,
  "controller" : "controller",
  "alternateMode" : "alternateMode",
  "horizontalResolution" : 7,
  "videoRam" : 5,
  "verticalResolution" : 1,
  "bitsPerPixel" : 4,
  "currentMode" : "currentMode",
  "directXMode" : "directXMode"
}, {
  "computerId" : 6,
  "controller" : "controller",
  "alternateMode" : "alternateMode",
  "horizontalResolution" : 7,
  "videoRam" : 5,
  "verticalResolution" : 1,
  "bitsPerPixel" : 4,
  "currentMode" : "currentMode",
  "directXMode" : "directXMode"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Success

400

Bad Request String

404

Not Found String

500

Server Error

401

Unauthorized

ComputerGroups

get /api/v1/groups/computers/{id}/members

Get a list of computers for a computer group (getComputerGroupMembers)

Path parameters

id (required)

Path Parameter — Computer Group Id format: int32

Query parameters

page (optional)

Query Parameter — The 1-based page number of the paged results to return

pageSize (optional)

Query Parameter — The number of records in each page

sort (optional)

Query Parameter — The column names and directions for sorting the results

filter (optional)

Query Parameter — A record-selection specification

fields (optional)

Query Parameter — The column names of the fields to return

Return type

array[ComputerDto]

Example data

Content-Type: application/json

[ {
  "lastUserName" : "lastUserName",
  "dontCare" : true,
  "virtualization" : "virtualization",
  "isInventoryManaged" : true,
  "vmPlatformName" : "vmPlatformName",
  "isMeterManaged" : true,
  "chassis" : "chassis",
  "lastUserId" : 1,
  "computerId" : 0,
  "isCamAgentInstalled" : true,
  "osPlatformName" : "osPlatformName",
  "primaryIpAddress" : "primaryIpAddress",
  "domainName" : "domainName",
  "name" : "name",
  "softwareInstallations" : 6
}, {
  "lastUserName" : "lastUserName",
  "dontCare" : true,
  "virtualization" : "virtualization",
  "isInventoryManaged" : true,
  "vmPlatformName" : "vmPlatformName",
  "isMeterManaged" : true,
  "chassis" : "chassis",
  "lastUserId" : 1,
  "computerId" : 0,
  "isCamAgentInstalled" : true,
  "osPlatformName" : "osPlatformName",
  "primaryIpAddress" : "primaryIpAddress",
  "domainName" : "domainName",
  "name" : "name",
  "softwareInstallations" : 6
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Success

400

Bad Request String

404

Not Found String

500

Server Error

401

Unauthorized

Network

get /api/v1/network/snmp/{id}

Get a network device discovered using SNMP (getSnmpDeviceById)

Path parameters

id (required)

Path Parameter — SnmpDeviceId format: int32

Query parameters

fields (optional)

Query Parameter — The column names of the fields to return

Return type

array[SnmpDeviceDto]

Example data

Content-Type: application/json

[ {
  "deviceType" : "deviceType",
  "serialNumber" : "serialNumber",
  "statusOid" : "statusOid",
  "isManagedDevice" : true,
  "descriptionOid" : "descriptionOid",
  "manufacturerName" : "manufacturerName",
  "ipAddress" : "ipAddress",
  "description" : "description",
  "services" : 6,
  "discoveredDate" : "2000-01-23T04:56:07.000+00:00",
  "deviceName" : "deviceName",
  "isHidden" : true,
  "snmpDeviceId" : 0,
  "upTime" : 1,
  "macAddress" : "macAddress",
  "upTimeOid" : "upTimeOid",
  "contact" : "contact",
  "serialNumberOid" : "serialNumberOid",
  "location" : "location",
  "contactOid" : "contactOid",
  "nameOid" : "nameOid",
  "locationOid" : "locationOid",
  "status" : "status"
}, {
  "deviceType" : "deviceType",
  "serialNumber" : "serialNumber",
  "statusOid" : "statusOid",
  "isManagedDevice" : true,
  "descriptionOid" : "descriptionOid",
  "manufacturerName" : "manufacturerName",
  "ipAddress" : "ipAddress",
  "description" : "description",
  "services" : 6,
  "discoveredDate" : "2000-01-23T04:56:07.000+00:00",
  "deviceName" : "deviceName",
  "isHidden" : true,
  "snmpDeviceId" : 0,
  "upTime" : 1,
  "macAddress" : "macAddress",
  "upTimeOid" : "upTimeOid",
  "contact" : "contact",
  "serialNumberOid" : "serialNumberOid",
  "location" : "location",
  "contactOid" : "contactOid",
  "nameOid" : "nameOid",
  "locationOid" : "locationOid",
  "status" : "status"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Success

400

Bad Request String

404

Not Found String

500

Server Error

401

Unauthorized

get /api/v1/network/snmp

Devices discovered using Network Device Discovery using the SNMP network protocol. (getSnmpDevices)

Query parameters

page (optional)

Query Parameter — The 1-based page number of the paged results to return

pageSize (optional)

Query Parameter — The number of records in each page

sort (optional)

Query Parameter — The column names and directions for sorting the results

filter (optional)

Query Parameter — A record-selection specification

fields (optional)

Query Parameter — The column names of the fields to return

Return type

array[SnmpDeviceDto]

Example data

Content-Type: application/json

[ {
  "deviceType" : "deviceType",
  "serialNumber" : "serialNumber",
  "statusOid" : "statusOid",
  "isManagedDevice" : true,
  "descriptionOid" : "descriptionOid",
  "manufacturerName" : "manufacturerName",
  "ipAddress" : "ipAddress",
  "description" : "description",
  "services" : 6,
  "discoveredDate" : "2000-01-23T04:56:07.000+00:00",
  "deviceName" : "deviceName",
  "isHidden" : true,
  "snmpDeviceId" : 0,
  "upTime" : 1,
  "macAddress" : "macAddress",
  "upTimeOid" : "upTimeOid",
  "contact" : "contact",
  "serialNumberOid" : "serialNumberOid",
  "location" : "location",
  "contactOid" : "contactOid",
  "nameOid" : "nameOid",
  "locationOid" : "locationOid",
  "status" : "status"
}, {
  "deviceType" : "deviceType",
  "serialNumber" : "serialNumber",
  "statusOid" : "statusOid",
  "isManagedDevice" : true,
  "descriptionOid" : "descriptionOid",
  "manufacturerName" : "manufacturerName",
  "ipAddress" : "ipAddress",
  "description" : "description",
  "services" : 6,
  "discoveredDate" : "2000-01-23T04:56:07.000+00:00",
  "deviceName" : "deviceName",
  "isHidden" : true,
  "snmpDeviceId" : 0,
  "upTime" : 1,
  "macAddress" : "macAddress",
  "upTimeOid" : "upTimeOid",
  "contact" : "contact",
  "serialNumberOid" : "serialNumberOid",
  "location" : "location",
  "contactOid" : "contactOid",
  "nameOid" : "nameOid",
  "locationOid" : "locationOid",
  "status" : "status"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Success

400

Bad Request String

404

Not Found String

500

Server Error

401

Unauthorized

Software

get /api/v1/software/installations

Get a list of software installed on one or more computers (getSoftwareInstallationsForAllComputers)

Query parameters

licenseUnitId (optional)

Query Parameter — The License Unit Id to filter format: int32

computerId (optional)

Query Parameter — The Computer Id to filter format: int32

page (optional)

Query Parameter — The 1-based page number of the paged results to return

pageSize (optional)

Query Parameter — The number of records in each page

sort (optional)

Query Parameter — The column names and directions for sorting the results

filter (optional)

Query Parameter — A record-selection specification

fields (optional)

Query Parameter — The column names of the fields to return

Return type

array[InstallationDto]

Example data

Content-Type: application/json

[ {
  "computerId" : 6,
  "applicationVersion" : "applicationVersion",
  "lastUsed" : "2000-01-23T04:56:07.000+00:00",
  "installPath" : "installPath",
  "computerName" : "computerName",
  "manufacturerName" : "manufacturerName",
  "manufacturerId" : 1,
  "platformName" : "platformName",
  "licenseUnitId" : 0,
  "applicationName" : "applicationName"
}, {
  "computerId" : 6,
  "applicationVersion" : "applicationVersion",
  "lastUsed" : "2000-01-23T04:56:07.000+00:00",
  "installPath" : "installPath",
  "computerName" : "computerName",
  "manufacturerName" : "manufacturerName",
  "manufacturerId" : 1,
  "platformName" : "platformName",
  "licenseUnitId" : 0,
  "applicationName" : "applicationName"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Success

400

Bad Request String

404

Not Found String

500

Server Error

401

Unauthorized

Users

get /api/v1/users/{id}/loginhistory

Get a list of user logins for a single user (apiV1UsersIdLoginhistoryGet)

Path parameters

id (required)

Path Parameter — User Id format: int32

Query parameters

page (optional)

Query Parameter — The 1-based page number of the paged results to return

pageSize (optional)

Query Parameter — The number of records in each page

sort (optional)

Query Parameter — The column names and directions for sorting the results

filter (optional)

Query Parameter — A record-selection specification

fields (optional)

Query Parameter — The column names of the fields to return

Return type

array[UserLoginDto]

Example data

Content-Type: application/json

[ {
  "computerId" : 6,
  "computerDomain" : "computerDomain",
  "computerName" : "computerName",
  "serverName" : "serverName",
  "serverDomain" : "serverDomain",
  "startTime" : "2000-01-23T04:56:07.000+00:00",
  "userDomain" : "userDomain",
  "endTime" : "2000-01-23T04:56:07.000+00:00",
  "userName" : "userName",
  "userId" : 0,
  "serverId" : 1,
  "uniqueId" : "uniqueId"
}, {
  "computerId" : 6,
  "computerDomain" : "computerDomain",
  "computerName" : "computerName",
  "serverName" : "serverName",
  "serverDomain" : "serverDomain",
  "startTime" : "2000-01-23T04:56:07.000+00:00",
  "userDomain" : "userDomain",
  "endTime" : "2000-01-23T04:56:07.000+00:00",
  "userName" : "userName",
  "userId" : 0,
  "serverId" : 1,
  "uniqueId" : "uniqueId"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Success

400

Bad Request String

404

Not Found String

500

Server Error

401

Unauthorized

get /api/v1/users/loginhistory

Get a list of user logins (apiV1UsersLoginhistoryGet)

Query parameters

page (optional)

Query Parameter — The 1-based page number of the paged results to return

pageSize (optional)

Query Parameter — The number of records in each page

sort (optional)

Query Parameter — The column names and directions for sorting the results

filter (optional)

Query Parameter — A record-selection specification

fields (optional)

Query Parameter — The column names of the fields to return

Return type

array[UserLoginDto]

Example data

Content-Type: application/json

[ {
  "computerId" : 6,
  "computerDomain" : "computerDomain",
  "computerName" : "computerName",
  "serverName" : "serverName",
  "serverDomain" : "serverDomain",
  "startTime" : "2000-01-23T04:56:07.000+00:00",
  "userDomain" : "userDomain",
  "endTime" : "2000-01-23T04:56:07.000+00:00",
  "userName" : "userName",
  "userId" : 0,
  "serverId" : 1,
  "uniqueId" : "uniqueId"
}, {
  "computerId" : 6,
  "computerDomain" : "computerDomain",
  "computerName" : "computerName",
  "serverName" : "serverName",
  "serverDomain" : "serverDomain",
  "startTime" : "2000-01-23T04:56:07.000+00:00",
  "userDomain" : "userDomain",
  "endTime" : "2000-01-23T04:56:07.000+00:00",
  "userName" : "userName",
  "userId" : 0,
  "serverId" : 1,
  "uniqueId" : "uniqueId"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Success

400

Bad Request String

404

Not Found String

500

Server Error

401

Unauthorized

get /api/v1/users/loginhistory/{id}

Get a single user login (apiV1UsersLoginhistoryIdGet)

Path parameters

id (required)

Path Parameter — Unique Id

Query parameters

page (optional)

Query Parameter — The 1-based page number of the paged results to return

pageSize (optional)

Query Parameter — The number of records in each page

sort (optional)

Query Parameter — The column names and directions for sorting the results

filter (optional)

Query Parameter — A record-selection specification

fields (optional)

Query Parameter — The column names of the fields to return

Return type

UserLoginDto

Example data

Content-Type: application/json

{
  "computerId" : 6,
  "computerDomain" : "computerDomain",
  "computerName" : "computerName",
  "serverName" : "serverName",
  "serverDomain" : "serverDomain",
  "startTime" : "2000-01-23T04:56:07.000+00:00",
  "userDomain" : "userDomain",
  "endTime" : "2000-01-23T04:56:07.000+00:00",
  "userName" : "userName",
  "userId" : 0,
  "serverId" : 1,
  "uniqueId" : "uniqueId"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Success UserLoginDto

400

Bad Request String

404

Not Found String

500

Server Error

401

Unauthorized

WebConsoleUrls

get /api/v1/webconsoleurls

Get web console urls (apiV1WebconsoleurlsGet)

Query parameters

fields (optional)

Query Parameter — The column names of the fields to return

Return type

WebConsoleUrlsDto

Example data

Content-Type: application/json

{
  "saasAnalyticsUrl" : "saasAnalyticsUrl",
  "licenseAnalyticsUrl" : "licenseAnalyticsUrl",
  "purchasingConsoleUrl" : "purchasingConsoleUrl",
  "camRestApiUrl" : "camRestApiUrl",
  "reportsConsoleUrl" : "reportsConsoleUrl",
  "authenticationUrl" : "authenticationUrl"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Success WebConsoleUrlsDto

400

Bad Request String

404

Not Found String

500

Server Error

401

Unauthorized

Models

Methods

CamAgentDto
ComputerDetailDto
ComputerDto
DriveDto
GroupDto
InstallationDto
MemoryDto
NetworkAdapterDto
PlatformDto
ProcessorDto
ServiceDto
SnmpDeviceDto
SystemInformationDto
UserLoginDto
VideoControllerDto
WebConsoleUrlsDto

`CamAgentDto`Up

The CAM Agent information for a computer provides information about whether a CAM Agent is now (or has ever been) installed, and version information.

computerId (optional)

Integer Id of computer to which this information applies format: int32

installState (optional)

Integer A numeric code that identifies the CAM Agent install state format: int32

installStateString (optional)

String A string that describes the install state

agentVersion (optional)

String The version string of the CAM Agent (null if none)

isDecommissioned (optional)

Boolean True if this computer has been parked as "pending deletion"

accessPointAddress (optional)

String URL address of the access point for the CAM Agent (null if none)

installDate (optional)

Date Date when the CAM Agent was last installed (null if none) format: date-time

lastInventory (optional)

Date Date when last inventory was performed (null if none) format: date-time

nextInventory (optional)

Date Date when next inventory is scheduled to be done (null if none) format: date-time

lastHeartbeat (optional)

Date Date when CAM Agent last checked into access point (null if none) format: date-time

isInventoryManaged (optional)

Boolean True if this computer does regular inventories

isMeterManaged (optional)

Boolean True if metering is enabled on this computer

`ComputerDetailDto`Up

Computer

computer (optional)

ComputerDto

systemInformation (optional)

SystemInformationDto

processor (optional)

ProcessorDto

memory (optional)

MemoryDto

platform (optional)

PlatformDto

camAgent (optional)

CamAgentDto

groups (optional)

array[GroupDto] Groups fields

videoControllers (optional)

array[VideoControllerDto] Video Controllers fields

drives (optional)

array[DriveDto] Drives fields

services (optional)

array[ServiceDto] Services fields

`ComputerDto`Up

Computer

computerId (optional)

Integer Id for this object format: int32

name (optional)

String Computer name DNS FQDN

domainName (optional)

String For Windows computers, the Windows domain

osPlatformName (optional)

String "Windows", "Linux", "Mac", etc.

virtualization (optional)

String "Host", "Guest", or "None"

vmPlatformName (optional)

String "VMware", "Hyper/V", etc. or "None"

softwareInstallations (optional)

Integer Number of software titles inventoried on this computer format: int32

isCamAgentInstalled (optional)

Boolean True if a CAM Agent is currently installed

lastUserId (optional)

Integer Id of last logged in user format: int32

lastUserName (optional)

String Name of last logged in user

dontCare (optional)

Boolean True if this computer has been moved into the Deleted folder

isInventoryManaged (optional)

Boolean True if this computer is "inventory managed"

isMeterManaged (optional)

Boolean True if this computer is "meter managed"

primaryIpAddress (optional)

String The IP address assigned to the first network adapter for this computer

chassis (optional)

String Chassis identification for this computer

`DriveDto`Up

This information describes the one or more drives that may be installed in a computer.

computerId (optional)

Integer Id of computer to which this information applies format: int32

driveId (optional)

Integer 1-based instance of this storage volume on this computer format: int32

mountPoint (optional)

String The name or path at which this volume is available

deviceName (optional)

String Name of volume or device, or mounted CD-ROM name

deviceType (optional)

String Drive type ("Removable", "Fixed", etc.)

volumeSize (optional)

Long Volume size in bytes (zero for removable devices) format: int64

percentUsed (optional)

Double Percentage of available device capacity in use format: double

fileSystemType (optional)

String Type of file system this device implements (FAT32, NTFS, EXT4, etc.)

`GroupDto`Up

The Computer Groups that exist within CAM.

computerGroupId (optional)

Integer Group Id for Group this computer belongs to format: int32

name (optional)

String Name of Group this computer belongs to

path (optional)

String Path of Group

`InstallationDto`Up

An Installation describes a single software title installed on a computer.

licenseUnitId (optional)

Integer License unit identifier format: int32

computerId (optional)

Integer Computer identifier format: int32

manufacturerId (optional)

Integer Manufacturer identifier format: int32

manufacturerName (optional)

String Manufacturer name

applicationName (optional)

String Name of application

applicationVersion (optional)

String Application version

computerName (optional)

String Computer name (domain\name or DNS)

platformName (optional)

String Name of computer software platform

installPath (optional)

String File system path to installed software

lastUsed (optional)

Date When this software was last used format: date-time

`MemoryDto`Up

The memory information for a computer identifies the amount of memory installed, the total number of memory sockets available on the hardware, and the number of memory sockets currently in use.

computerId (optional)

Integer Id of computer to which this information applies format: int32

size (optional)

Long Number of bytes of memory installed format: int64

slotsAvailable (optional)

Integer Total number of memory device slots provided on this device format: int32

slotsInUse (optional)

Integer Number of memory device slots currently in use format: int32

`NetworkAdapterDto`Up

The network adapter information is an array of objects, each of which is a network adapter connected to a computer. The underlying DB schema uses an "instance number" for each adapter. The instance number is just a per-computer index.

computerId (optional)

Integer Id of computer to which this information applies format: int32

adapterId (optional)

Integer Instance Id of this service format: int32

name (optional)

String Network adapter name

description (optional)

String Network adapter description

macAddress (optional)

String MAC (network hardware) address for this network adapter

ipAddress (optional)

String IP address assigned to this network adapter

subnetMask (optional)

String Sub-net mask for the IP network

adapterType (optional)

String Adapter type information (usually blank)

dhcpServer (optional)

String IP address of DHCP server

winsPrimary (optional)

String IP address of DHCP server

winsSecondary (optional)

String IP address of secondary WINS server

dhcpLeaseObtained (optional)

Date Time at which the DHCP lease for the IP address was obtained format: date-time

dhcpLeaseExpires (optional)

Date Time at which the DHCP lease for the address will expire format: date-time

dhcpEnabled (optional)

Boolean True if DHCP configuration is enabled

autoConfigureEnabled (optional)

Boolean True if this adapter is auto-configured

dnsServers (optional)

array[String] The IP addresses of all DNS servers used by this computer

gateways (optional)

array[String] The IP address of all network gateways used by this computer

dnsSuffix (optional)

String The DNS suffix used to form network device names on this network

mediaDisconnected (optional)

Boolean True if this network adapter is not connected to a network

`PlatformDto`Up

The platform information for a computer identifies the software platform in use, both the general type and the specific OS (if known).

computerId (optional)

Integer Id of computer to which this information applies format: int32

name (optional)

String Platform name (enumeration)

operatingSystem (optional)

String Operating system name

osVersion (optional)

String Operating system version

osServicePack (optional)

String Operating system service pack

osManufacturer (optional)

String Operating system publisher

osLocale (optional)

String Operating system locale (e.g., "en-US")

osTimeZone (optional)

String Operating system time zone (format undefined)

vmPlatformName (optional)

String ("VMware", "Hyper/V", etc.) or "None"

virtualization (optional)

String Type of VM environment ("Host", "Guest", or "None")

`ProcessorDto`Up

The processor information for a computer identifies the processor type and the number of processors and cores installed.

computerId (optional)

Integer Id of computer to which this information applies format: int32

identification (optional)

String An identification string for the processor type (from the processor)

processors (optional)

Integer Number of processors installed (as reported by OS or BIOS) format: int32

logicalProcessors (optional)

Integer Number of processors installed based on HyperThreading format: int32

cores (optional)

Integer Number of processor cores installed (as reported by OS or BIOS) format: int32

speed (optional)

Integer The processor clock rate ("speed") in MHz format: int32

`ServiceDto`Up

This describes the services (software processes managed by the OS) configured to run on a computer.

computerId (optional)

Integer Id of computer to which this information applies format: int32

serviceId (optional)

Integer Instance Id of this service format: int32

name (optional)

String An internal name for this service

displayName (optional)

String An alternate name for this service

state (optional)

String Usually "Running" or "Stopped"

startMode (optional)

String Usually "Auto", "Manual", "Disabled"

isRunning (optional)

Boolean True if service running when inventoried

command (optional)

String Command or executable used to start the service

`SnmpDeviceDto`Up

Network devices are things that CAM discovers by means of SNMP discovery. This information is siloed (for now). There is no way to directly relate purchasing information or software license information to SNMP devices.

snmpDeviceId (optional)

Integer Surrogate key in network devices table format: int32

deviceName (optional)

String Device name

manufacturerName (optional)

String Manufacturer name

description (optional)

String Some descriptive information

services (optional)

Integer A value generated by the device to indicate the services (sysServices) the device could potentially offer format: int32

deviceType (optional)

String "Router", "SNMP Device", "Printer", etc.

serialNumber (optional)

String Device serial number

ipAddress (optional)

String IP address at which this device was discovered

macAddress (optional)

String Network adapter address

upTime (optional)

Integer Up time in seconds format: int32

status (optional)

String "Up", "Down", "Invalid"

contact (optional)

String Contact defined by the device

location (optional)

String Location defined by the device

discoveredDate (optional)

Date Date when first discovered by CAM format: date-time

isHidden (optional)

Boolean Denotes a device that has been deleted in the CAM Administrator console

isManagedDevice (optional)

Boolean Indicates that the discovered device is actually of a machine that�s managed

nameOid (optional)

String The OID on the network device used to retrieve the Device Name

descriptionOid (optional)

String The OID on the network device used to retrieve the Description

serialNumberOid (optional)

String The OID on the network device used to retrieve the Serial Number

upTimeOid (optional)

String The OID on the network device used to retrieve the Up Time

statusOid (optional)

String The OID on the network device used to retrieve the Status

contactOid (optional)

String The OID on the network device used to retrieve the Contact

locationOid (optional)

String The OID on the network device used to retrieve the Location

`SystemInformationDto`Up

System information provides supplementary identification information for a computer.

computerId (optional)

Integer Id of computer to which this information applies format: int32

primaryNicAddress (optional)

String The MAC address of what appears to be the primary network interface controller

primaryIpAddress (optional)

String The IP address assigned to what appears to be the primary network interface

primaryHdSerialNumber (optional)

Integer The serial number of what appears to be the primary mass storage device format: int32

systemSerialNumber (optional)

String A serial number read from the computing hardware

smsId (optional)

String A serial number assigned by Microsoft's System Management Server

productName (optional)

String Product name (from BIOS)

modelName (optional)

String Product model name (from BIOS)

manufacturerName (optional)

String Manufacturer name (from BIOS)

enclosureName (optional)

String Enclosure name (from BIOS)

chassis (optional)

String Chassis type (from BIOS)

biosName (optional)

String Name of BIOS

biosVersion (optional)

String Version string from BIOS

biosDate (optional)

String Date string from BIOS

biosSerialNumber (optional)

String Serial number from BIOS

`UserLoginDto`Up

A user�s login history provides information about all computers and terminal servers a user has accessed over some time.

uniqueId (optional)

String Unique identifier

userId (optional)

Integer Id of user who logged in format: int32

computerId (optional)

Integer Id of computer the user logged in to format: int32

serverId (optional)

Integer Id of the terminal server used (0 if none) format: int32

userName (optional)

String Name of user

userDomain (optional)

String Name of user's domain

computerName (optional)

String Name of computer

computerDomain (optional)

String Name of computer''s domain

serverName (optional)

String Name of server (null if none)

serverDomain (optional)

String Name of server's domain (null if none)

startTime (optional)

Date Date and time login session started format: date-time

endTime (optional)

Date Date and time the login session ended - this field may be blank in some scenarios format: date-time

`VideoControllerDto`Up

This information describes the video controller installed in a computer.

computerId (optional)

Integer Id of computer to which this information applies format: int32

controller (optional)

String Video controller name

currentMode (optional)

String Current video mode

alternateMode (optional)

String Alternate video mode

horizontalResolution (optional)

Integer Video mode horizontal resolution in pixels format: int32

verticalResolution (optional)

Integer Video mode vertical resolution in pixels format: int32

bitsPerPixel (optional)

Integer Number of color bits per pixel format: int32

videoRam (optional)

Long Video memory adapter in bytes format: int64

directXMode (optional)

String Direct-X mode supported by video driver

`WebConsoleUrlsDto`Up

Contains location information for all of CAM's web applications

purchasingConsoleUrl (optional)

String URL for Purchasing Console

reportsConsoleUrl (optional)

String URL for Reports Console

licenseAnalyticsUrl (optional)

String URL for License Analytics

authenticationUrl (optional)

String URL for Authentication

saasAnalyticsUrl (optional)

String URL for SaaS Analytics

camRestApiUrl (optional)

String URL for CAM REST API Documentation

Data Service

Access

Methods

Table of Contents

Computer

ComputerGroups

Network

Software

Users

WebConsoleUrls

Computer

Path parameters

Query parameters

Return type

Example data

Produces

Responses

200

400

404

500

401

Path parameters

Query parameters

Return type

Example data

Produces

Responses

200

400

404

500

401

Path parameters

Query parameters

Return type

Example data

Produces

Responses

200

400

404

500

401

Query parameters

Return type

Example data

Produces

Responses

200

400

404

500

401

Path parameters

Query parameters

Return type

Example data

Produces

Responses

200

400

404

500

401

Path parameters

Return type

Example data

Produces

Responses

200

400

404

500

401

Path parameters

Query parameters

Return type

Example data

Produces