Endpoint
/api/v2/tenants/{tenantId}/resources/search

  • Query string should be valid input values
    • Eg 1: state values are enum: active/inactive
      “queryString=state:active” or “queryString=state:inactive”
    • Eg 2: we should allow only above listed variables
      “queryString=hostName:abc” //valid
      “queryString=hostName2:abc” //Invalid
    • Eg 3: We should give both variable name and value
      “queryString=hostName:abc” //valid
      “queryString=hostName” //Invalid

Path Parameters
tenantId
string

Describes the client ID of the tenant

Query Parameters
pageNo
integer

pageSize
integer

isDescendingOrder
boolean

sortName
string

queryString
string

includeStatus
boolean

Responses

OK

descendingOrder
boolean

nextPage
boolean

orderBy
string

pageNo
integer

pageSize
integer

previousPageNo
integer

results
array

results.agentInstalled
results.aliasName
results.appRoles
results.assetManagedTime
results.attributes
results.bios
results.classCode
results.client
results.clientId
results.clientUniqueId
results.components
results.consoles
results.cpus
results.createdDate
results.deleted
results.description
results.devicePath
results.deviceType
results.dns
results.extResourceId
results.firstAssetManagedTime
results.gatewayProfileId
results.generalInfo
results.history
results.hostName
results.id
results.identity
results.installedApp
results.ipAddress
results.location
results.locationOffset
results.logicalDisks
results.macAddress
results.make
results.managementProfile
results.metricTypes
results.model
results.name
results.networkCards
results.osArchitecture
results.osName
results.physicalDisks
results.properties
results.resourceName
results.resourceType
results.serialNumber
results.source
results.state
results.status
results.systemUID
results.tags
results.totalLocations
results.ts
results.type
results.updatedDate
results.videoCards
results.wsusSettings
totalPages
integer

totalResults
integer

{
  "descendingOrder": false,
  "nextPage": false,
  "pageNo": 1,
  "pageSize": 100,
  "results": [
    {
      "agentInstalled": true,
      "aliasName": "HYDLPT216@OpsRamp",
      "attributes": {
        "ami": "ami-84562dec",
        "instanceId": "i-373dcec7",
        "instanceState": "running",
        "instanceType": "t1.micro",
        "launchDate": "2015-11-03T21:14:28+0000",
        "monitoringState": "disabled",
        "owner": "23422135901",
        "privateDns": "ip-10-33-136-158.ec2.internal",
        "privateIp": "12.32.345.132",
        "provider": "AWS",
        "publicIp": "54.211.85.6",
        "zone": "us-east-1e"
      },
      "description": "BIOS Date: 09/12/19 00:52:26 Ver: 1.6.4.00 ",
      "devicePath": "Server \u003e\u003e Linux",
      "deviceType": "Linux",
      "dns": "opsrampdev",
      "dnsName": "opsrampdev",
      "hostName": "SJLPT3311",
      "id": "840e216d-77ae-46d0-85ca-414e41607b15",
      "ipAddress": "151.43.122.54",
      "macAddress": "0A:00:27:00:00:02",
      "make": "innotek GmbH",
      "managementProfile": {
        "id": 7,
        "name": "vg-ubuntu16",
        "type": "Gateway"
      },
      "model": "VirtualBox",
      "name": "SJLPT117",
      "osArchitecture": "32",
      "osName": "Ubuntu 16.04.4 LTS",
      "resiurceType": "Linux",
      "resourceName": "SJLPT216",
      "serialNumber": "7GU9NH2",
      "state": "active",
      "systemUID": "906H6874-1246-4H60-9012-D4C04F4E4123",
      "tags": [
        {
          "name": "vmtesttag",
          "value": "tagvalue"
        }
      ],
      "type": "DEVICE",
      "updatedDate": "2019-08-02T10:24:16+0000"
    },
    {
      "agentInstalled": true,
      "aliasName": "HYDLPE2211@OpsRamp",
      "attributes": {
        "ami": "ami-84562dec",
        "instanceId": "i-453dccd2",
        "instanceState": "running",
        "instanceType": "t1.micro",
        "launchDate": "2015-11-03T21:14:28+0000",
        "monitoringState": "disabled",
        "owner": "321432654123",
        "privateDns": "ip-11-12-142-221.ec2.internal",
        "privateIp": "11.12.142.221",
        "provider": "AWS",
        "publicIp": "52.321.54.2",
        "zone": "us-east-1e"
      },
      "description": "BIOS Date : 09/12/17 00:52:26 Ver : 1.6.4.00 ",
      "devicePath": "Server \u003e\u003e Linux",
      "deviceType": "Linux",
      "dns": "opsrampdev",
      "dnsName": "opsrampdev",
      "hostName": "SJJCD110022",
      "id": "740e2b6d-77ae-46d0-85ca-414e41607b15",
      "ipAddress": "142.11.32.12",
      "macAddress": "0A:00:12:00:00:02",
      "make": "innotek GmbH",
      "managementProfile": {
        "id": 7,
        "name": "vg-ubuntu16",
        "type": "Gateway"
      },
      "model": "VirtualBox",
      "name": "SJJCD110022",
      "osArchitecture": "64",
      "osName": "Ubuntu 16.04.4 LTS",
      "resourceName": "SJJCD110022",
      "serialNumber": "8FL9NH2",
      "state": "Decommissioned",
      "systemUID": "5D6C3423-2123-5F21-6836-H5D75G6G1232",
      "tags": [
        {
          "name": "Device location",
          "value": "SJ"
        }
      ],
      "type": "DEVICE",
      "updatedDate": "2018-08-02T10:24:16+0000"
    }
  ],
  "totalPages": 1,
  "totalResults": 2
}
{
  "descendingOrder": false,
  "nextPage": false,
  "orderBy": "name",
  "pageNo": 1,
  "pageSize": 100,
  "results": [
    {
      "agentInstalled": false,
      "aliasName": "TestAlias",
      "assetManagedTime": "2019-05-20T09:31:50+0000",
      "attributes": {
        "network": [
          {
            "aliasIp": "172.24.133.100, 172.24.133.101",
            "ip": "172.24.133.91",
            "mac": "f8:94:c2:0c:10:f2"
          }
        ]
      },
      "classCode": "device",
      "client": {
        "id": 4,
        "name": "EHR",
        "uniqueId": "client_4"
      },
      "clientId": 0,
      "consoles": [],
      "createdDate": "2019-05-20T09:31:50+0000",
      "deleted": false,
      "description": "test dummy device",
      "deviceGroups": [
        {
          "createdDate": "2021-03-15T15:01:39+0000",
          "description": "",
          "id": "99",
          "linkedService": false,
          "name": "RegressionTest",
          "updatedDate": "2021-03-15T17:14:55+0000"
        },
        {
          "createdDate": "2021-04-22T01:04:45+0000",
          "description": "",
          "id": "102",
          "linkedService": false,
          "name": "PolicyDevGroup",
          "updatedDate": "2021-04-22T01:04:46+0000"
        }
      ],
      "devicePath": "Desktop",
      "deviceType": "Desktop",
      "dns": "TestHost.testDomain.com",
      "dnsName": "TestHost.testDomain.com",
      "firstAssetManagedTime": "2019-05-20T09:31:50+0000",
      "gatewayProfileId": "0",
      "hostName": "TestHost",
      "id": "61fec02a-4370-4dfb-be4d-1bb9fe3e05aa",
      "ipAddress": "10.1.1.2",
      "location": {
        "address": "",
        "city": "",
        "description": "",
        "id": 233,
        "name": "Location2",
        "path": "Location2"
      },
      "locationOffset": 0,
      "make": "",
      "model": "",
      "name": "TestHost",
      "osArchitecture": "32",
      "osName": "",
      "resourceName": "TestResource",
      "resourceType": "Desktop",
      "source": "MANUAL",
      "state": "active",
      "totalLocations": 0,
      "ts": 0,
      "type": "DEVICE"
    }
  ],
  "totalPages": 1,
  "totalResults": 1
}
{
  "descendingOrder": false,
  "nextPage": false,
  "orderBy": "name",
  "pageNo": 1,
  "pageSize": 100,
  "results": [
    {
      "agentInstalled": false,
      "aliasName": "TestAlias",
      "assetManagedTime": "2019-05-20T09:31:50+0000",
      "attributes": {
        "network": [
          {
            "aliasIp": "172.24.133.100, 172.24.133.101",
            "ip": "172.24.133.91",
            "mac": "f8:94:c2:0c:10:f2"
          }
        ]
      },
      "classCode": "device",
      "client": {
        "id": 4,
        "name": "EHR",
        "uniqueId": "client_4"
      },
      "clientId": 0,
      "consoles": [],
      "createdDate": "2019-05-20T09:31:50+0000",
      "deleted": false,
      "description": "test dummy device",
      "deviceGroups": [
        {
          "createdDate": "2021-03-15T15:01:39+0000",
          "description": "",
          "id": "99",
          "linkedService": false,
          "name": "RegressionTest",
          "updatedDate": "2021-03-15T17:14:55+0000"
        },
        {
          "createdDate": "2021-04-22T01:04:45+0000",
          "description": "",
          "id": "102",
          "linkedService": false,
          "name": "PolicyDevGroup",
          "updatedDate": "2021-04-22T01:04:46+0000"
        }
      ],
      "devicePath": "Desktop",
      "deviceType": "Desktop",
      "dns": "",
      "dnsName": "",
      "firstAssetManagedTime": "2019-05-20T09:31:50+0000",
      "gatewayProfileId": "0",
      "hostName": "TestHost",
      "id": "61fec02a-4370-4dfb-be4d-1bb9fe3e05aa",
      "ipAddress": "1.1.1.2",
      "location": {
        "address": "",
        "city": "",
        "description": "",
        "id": 233,
        "name": "Location2",
        "path": "Location2"
      },
      "locationOffset": 0,
      "make": "",
      "model": "",
      "name": "TestHost",
      "osArchitecture": "32",
      "osName": "",
      "resourceName": "TestResource",
      "resourceType": "Desktop",
      "source": "MANUAL",
      "state": "active",
      "totalLocations": 0,
      "ts": 0,
      "type": "DEVICE"
    }
  ],
  "totalPages": 1,
  "totalResults": 1
}