Inventory Batch Export - JSON Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"$ref": "#/definitions/Example",
"definitions": {
"Example": {
"type": "object",
"additionalProperties": false,
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/definitions/Result"
}
},
"totalResults": {
"type": "integer"
},
"orderBy": {
"type": "string"
},
"pageNo": {
"type": "integer"
},
"pageSize": {
"type": "integer"
},
"totalPages": {
"type": "integer"
},
"nextPage": {
"type": "boolean"
},
"descendingOrder": {
"type": "boolean"
}
},
"required": [
"descendingOrder",
"nextPage",
"orderBy",
"pageNo",
"pageSize",
"results",
"totalPages",
"totalResults"
],
"title": "Example"
},
"Result": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"hostName": {
"type": "string"
},
"ipAddress": {
"type": "string"
},
"dns": {
"type": "string"
},
"dnsName": {
"type": "string"
},
"client": {
"$ref": "#/definitions/Client"
},
"identity": {
"type": "string"
},
"createdDate": {
"type": "string"
},
"updatedDate": {
"type": "string"
},
"classCode": {
"type": "string"
},
"deviceType": {
"type": "string"
},
"devicePath": {
"type": "string"
},
"type": {
"type": "string"
},
"state": {
"type": "string"
},
"macAddress": {
"type": "string"
},
"make": {
"type": "string"
},
"model": {
"type": "string"
},
"biosName": {
"type": "string"
},
"biosVersion": {
"type": "string"
},
"osName": {
"type": "string"
},
"osArchitecture": {
"type": "string"
},
"serialNumber": {
"type": "string",
"format": "uuid"
},
"systemUID": {
"type": "string",
"format": "uuid"
},
"description": {
"type": "string"
},
"gatewayProfileId": {
"type": "string",
"format": "integer"
},
"source": {
"type": "string"
},
"agentInstalled": {
"type": "boolean"
},
"agentInstalledTime": {
"type": "string"
},
"agentVersion": {
"type": "string"
},
"status": {
"type": "string"
},
"attributes": {
"$ref": "#/definitions/Attributes"
},
"aliasName": {
"type": "string"
},
"managementProfile": {
"$ref": "#/definitions/ManagementProfile"
},
"location": {
"$ref": "#/definitions/Location"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/definitions/Tag"
}
},
"name": {
"type": "string"
},
"resourceName": {
"type": "string"
},
"consoles": {
"type": "array",
"items": {}
},
"deviceGroups": {
"type": "array",
"items": {
"$ref": "#/definitions/DeviceGroup"
}
},
"resourceType": {
"type": "string"
},
"appRoles": {
"type": "array",
"items": {
"$ref": "#/definitions/AppRole"
}
},
"assetManagedTime": {
"type": "string"
},
"firstAssetManagedTime": {
"type": "string"
},
"lastMetricValue": {
"type": "integer"
}
},
"required": [
"agentInstalled",
"agentInstalledTime",
"agentVersion",
"aliasName",
"appRoles",
"assetManagedTime",
"attributes",
"biosName",
"biosVersion",
"classCode",
"client",
"consoles",
"createdDate",
"description",
"deviceGroups",
"devicePath",
"deviceType",
"dns",
"dnsName",
"firstAssetManagedTime",
"gatewayProfileId",
"hostName",
"id",
"identity",
"InstalledApp",
"ipAddress",
"location",
"lastMetricValue",
"macAddress",
"make",
"managementProfile",
"model",
"name",
"osArchitecture",
"osName",
"properties",
"resourceName",
"resourceType",
"serialNumber",
"source",
"state",
"status",
"systemUID",
"tags",
"type",
"updatedDate"
],
"title": "Result"
},
"AppRole": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
],
"title": "AppRole"
},
"Attributes": {
"type": "object",
"additionalProperties": false,
"properties": {
"network": {
"type": "array",
"items": {
"$ref": "#/definitions/Network"
}
}
},
"required": [
"network"
],
"title": "Attributes"
},
"Network": {
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"type": "string"
},
"mac": {
"type": "string"
}
},
"required": [
"ip"
],
"title": "Network"
},
"Client": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer"
},
"uniqueId": {
"type": "string"
},
"name": {
"type": "string"
},
"featureFlags": {
"$ref": "#/definitions/FeatureFlags"
},
"webConsoles": {
"type": "boolean"
}
},
"required": [
"featureFlags",
"id",
"name",
"uniqueId",
"webConsoles"
],
"title": "Client"
},
"FeatureFlags": {
"type": "object",
"additionalProperties": false,
"title": "FeatureFlags"
},
"DeviceGroup": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "integer"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"createdDate": {
"type": "string"
},
"updatedDate": {
"type": "string"
},
"linkedService": {
"type": "boolean"
}
},
"required": [
"createdDate",
"description",
"id",
"linkedService",
"name",
"updatedDate"
],
"title": "DeviceGroup"
},
"Location": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"address": {
"type": "string"
},
"city": {
"type": "string"
},
"path": {
"type": "string"
},
"state": {
"type": "string"
},
"country": {
"type": "string"
}
},
"required": [
"address",
"city",
"description",
"id",
"name",
"path",
"state",
"country"
],
"title": "Location"
},
"ManagementProfile": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"delete": {
"type": "boolean"
}
},
"required": [
"delete",
"id",
"name",
"type"
],
"title": "ManagementProfile"
},
"Tag": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "Tag"
},
"InstalledApp": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"displayName": {
"type": "string"
},
"integration": {
"$ref": "#/definitions/Integration"
},
"forceDeleteStaleEntries": {
"type": "boolean"
},
"skipDeleteResources": {
"type": "boolean"
},
"multiConfigsAvailable": {
"type": "boolean"
},
"multiAppsDiscoveryEnabled": {
"type": "boolean"
},
"enableGlobalPolicies": {
"type": "boolean"
},
"keepAgentInstalledResources": {
"type": "boolean"
},
"deleteAssociatedChildAccounts": {
"type": "boolean"
},
"streamExportsEnabled": {
"type": "boolean"
},
"acceptConditions": {
"type": "boolean"
},
"logManagementEnabled": {
"type": "boolean"
},
"traceManagementEnabled": {
"type": "boolean"
}
},
"required": [
"acceptConditions",
"deleteAssociatedChildAccounts",
"displayName",
"enableGlobalPolicies",
"forceDeleteStaleEntries",
"id",
"integration",
"keepAgentInstalledResources",
"logManagementEnabled",
"multiAppsDiscoveryEnabled",
"multiConfigsAvailable",
"skipDeleteResources",
"streamExportsEnabled",
"traceManagementEnabled"
]
},
"Integration": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"integrationId": {
"type": "integer"
},
"provisionUserWithTenantPrefix": {
"type": "boolean"
}
},
"required": [
"id",
"integrationId",
"name",
"provisionUserWithTenantPrefix"
]
}
}
}
Inventory Batch Export - JSON Response
[
{
"id": "4defe5f0-56b8-4d60-a253-b2273a5361d3",
"hostName": "",
"ipAddress": "",
"client": {
"id": 8,
"uniqueId": "client_8",
"name": "Demo Client",
"enablePRCLogsSource": false,
"enablePRCAlertsSource": false,
"featureFlags": {},
"webConsoles": true
},
"entityType": "RESOURCE",
"createdDate": "2019-12-01T00:31:48+0000",
"classCode": "generic.resource",
"state": "active",
"make": "AZURE",
"gatewayProfileId": "0",
"source": "MANUAL",
"status": "UNDEFINED",
"aliasName": "",
"name": "opscloudev.onmicrosoft.com",
"resourceName": "opscloudev.onmicrosoft.com",
"generalInfo": {},
"consoles": [],
"installedApp": {
"id": "INTG-b6d8e173-9080-475e-bc71-905b1e4e50a9",
"displayName": "Azure Sales",
"integration": {
"id": "AZURE",
"name": "Azure",
"integrationId": 0,
"provisionUserWithTenantPrefix": false
},
"forceDeleteStaleEntries": false,
"skipDeleteResources": false,
"multiConfigsAvailable": false,
"multiAppsDiscoveryEnabled": false,
"enableGlobalPolicies": false,
"keepAgentInstalledResources": false,
"deleteAssociatedChildAccounts": false,
"streamExportsEnabled": false,
"acceptConditions": false,
"logManagementEnabled": false,
"traceManagementEnabled": false
},
"properties": {
"providerType": "AZURE",
"accountNumber": "4fd985a7-560d-4fa4-b226-9e0384931cd2",
"accountName": "Azure Sales"
},
"resourceType": "AZ_AD_B2C",
"resourcePath": "Active Directory B2C",
"frequency": 0,
"paused": false,
"deleted": false,
"validateSSL": false,
"port": 0,
"encrypted": false,
"timeout": 0,
"ts": 0,
"clientId": 0,
"locationOffset": 0,
"totalLocations": 0,
"receiverHostPort": 0,
"absoluteTime": false,
"msp": {
"id": 3,
"uniqueId": "msp_3",
"name": "Demo Partner",
"featureFlags": {},
"clientCreationDisabled": false
},
"topologyEnabled": false,
"resourceId": 21013,
"device": false,
"excludeIndexing": false,
"cloudInstance": false,
"saId": 0,
"postScreenshotOnError": false,
"postSuccessScreenshotAlongWithError": false,
"lastMetricValue": 50
},
{
"id": "6c828963-c2d5-4c58-bb3d-f15ae0caf335",
"hostName": "",
"ipAddress": "",
"client": {
"id": 31613,
"uniqueId": "9791ce02-c642-45c3-b65f-791fb67c0020",
"name": "Hyd-Lab",
"enablePRCLogsSource": false,
"enablePRCAlertsSource": false,
"featureFlags": {},
"webConsoles": true
},
"entityType": "RESOURCE",
"createdDate": "2023-07-27T05:55:05+0000",
"classCode": "CLOUD_PROVIDER",
"state": "active",
"gatewayProfileId": "0",
"source": "MANUAL",
"status": "UNDEFINED",
"aliasName": "",
"name": "npm-collector-Test",
"resourceName": "",
"generalInfo": {},
"consoles": [],
"resourceType": "CLOUD_PROVIDER",
"resourcePath": "Cloud Provider",
"frequency": 0,
"paused": false,
"deleted": false,
"validateSSL": false,
"port": 0,
"encrypted": false,
"timeout": 0,
"ts": 0,
"clientId": 0,
"locationOffset": 0,
"totalLocations": 0,
"receiverHostPort": 0,
"absoluteTime": false,
"msp": {
"id": 31593,
"uniqueId": "faf0024f-598d-45e2-87f7-9f3d77fe49bd",
"name": "Ops-Lab",
"featureFlags": {}
},
"topologyEnabled": false,
"resourceId": 3136928,
"device": false,
"excludeIndexing": false,
"cloudInstance": false,
"saId": 0,
"postScreenshotOnError": false,
"postSuccessScreenshotAlongWithError": false
},
{
"id": "d8c56056-eee7-49e5-bc7c-badbb5a2c2d0",
"hostName": "AGENT-WINDOWS7-",
"ipAddress": "10.11.1.4",
"dns": "agent-windows7-",
"client": {
"id": 31613,
"uniqueId": "9791ce02-c642-45c3-b65f-791fb67c0020",
"name": "Hyd-Lab",
"enablePRCLogsSource": false,
"enablePRCAlertsSource": false,
"featureFlags": {},
"webConsoles": true
},
"entityType": "RESOURCE",
"createdDate": "2023-09-27T11:06:39+0000",
"updatedDate": "2023-09-27T11:17:26+0000",
"classCode": "cloudinstance",
"state": "active",
"macAddress": "00:22:48:06:97:F0",
"osName": "Microsoft Windows 7 Enterprise Service Pack 1 6.1.7601.25984 Build 7601.25984.25984",
"serialNumber": "0000-0012-3842-7991-8012-2195-74",
"systemUID": "ABDDCCF8-801F-40B6-A47B-E54F89A9C861",
"gatewayProfileId": "0",
"source": "Agent",
"agentInstalled": false,
"status": "UNDEFINED",
"aliasName": "",
"location": {
"id": 1627779,
"name": "Dev Test",
"clientId": 31613,
"mspId": 31593,
"description": "",
"address": "",
"city": "Hyderabad",
"state": "Telangana",
"country": "India",
"path": "Dev Test",
"rootLocation": "Dev Test"
},
"name": "AGENT-WINDOWS7-",
"resourceName": "",
"bios": {
"systemSerial": "0000-0012-3842-7991-8012-2195-74"
},
"generalInfo": {
"domainRole": "1",
"keyboardType": "US104",
"encodingType": "UTF8",
"physicalMemory": "0.0",
"agentDeploytime": "2023-09-27T11:06:39+0000"
},
"agentConnectivity": "DIRECT",
"consoles": [
{
"ipAddress": "127.0.0.1",
"port": "3389",
"consoleConnector": "Agent",
"consoleAuthType": "PASSWORD",
"consoleProtocol": "RDP",
"type": "MANAGEMENTCONSOLE",
"enableUploadOrDownload": false
},
{
"ipAddress": "127.0.0.1",
"port": "0",
"consoleConnector": "Agent",
"consoleAuthType": "PASSWORD",
"consoleProtocol": "FTRANSFER",
"type": "MANAGEMENTCONSOLE",
"enableUploadOrDownload": false
},
{
"ipAddress": "127.0.0.1",
"port": "0",
"consoleConnector": "Agent",
"consoleAuthType": "PASSWORD",
"consoleProtocol": "RMSHELL",
"type": "MANAGEMENTCONSOLE",
"enableUploadOrDownload": false
}
],
"properties": {
"instanceId": "/subscriptions/a0803c92-fc30-404a-b5e2-636ccf59d5b9/resourceGroups/Agent/providers/Microsoft.Compute/virtualMachines/agent-windows7-vm01"
},
"resourceType": "Work Station",
"resourcePath": "Desktop >> Work Station",
"wsusSettings": "disabled",
"assetManagedTime": "2023-09-27T11:06:39+0000",
"firstAssetManagedTime": "2023-09-27T11:06:39+0000",
"frequency": 0,
"paused": false,
"deleted": false,
"validateSSL": false,
"port": 0,
"encrypted": false,
"timeout": 0,
"ts": 0,
"clientId": 0,
"locationOffset": 0,
"totalLocations": 0,
"receiverHostPort": 0,
"absoluteTime": false,
"msp": {
"id": 31593,
"uniqueId": "faf0024f-598d-45e2-87f7-9f3d77fe49bd",
"name": "Ops-Lab",
"featureFlags": {}
},
"topologyEnabled": false,
"resourceId": 5103884,
"device": false,
"excludeIndexing": false,
"cloudInstance": false,
"saId": 0,
"postScreenshotOnError": false,
"postSuccessScreenshotAlongWithError": false
}
]