[Index]
License Audit Counts.
Model ref.: data/LicenseAuditCounts
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"properties": {
"customer": {
"required": false,
"type": "string",
"description": "Customer",
"title": "Customer"
},
"ms_teams_voice_users": {
"default": 0,
"required": true,
"type": "integer",
"description": "The MS Teams voice user count for this hierarchy.",
"title": "MS Teams Voice Users"
},
"reseller": {
"required": false,
"type": "string",
"description": "Reseller",
"title": "Reseller"
},
"customer_pkid": {
"readonly": true,
"required": true,
"type": "string",
"description": "The customer PKID.",
"title": "Customer PKID"
},
"timestamp": {
"title": "Timestamp",
"required": true,
"type": "string",
"description": "The timestamp when the counts were created.",
"format": "date-time"
},
"msol_users": {
"default": 0,
"required": true,
"type": "integer",
"description": "The MS Online user count for this hierarchy.",
"title": "MS Online Users"
},
"meeting_rooms": {
"default": 0,
"required": true,
"type": "integer",
"description": "Meeting Room license count for this hierarchy.",
"title": "Meeting Rooms"
},
"cisco_and_ms_integrated_services": {
"default": 0,
"required": true,
"type": "integer",
"description": "Cisco and Microsoft Integrated Service license count for this hierarchy.",
"title": "Cisco and MS Integrated Services"
},
"sites": {
"default": 0,
"required": true,
"type": "integer",
"description": "The site count for this hierarchy.",
"title": "Sites"
},
"user_licenses": {
"default": 0,
"required": true,
"type": "integer",
"description": "The user license count for this hierarchy.",
"title": "User Licenses"
},
"standalone_devices": {
"default": 0,
"required": true,
"type": "integer",
"description": "Standalone Device license count for this hierarchy.",
"title": "Standalone Devices"
},
"provider": {
"required": false,
"type": "string",
"description": "Provider",
"title": "Provider"
},
"users_with_more_than_10_devices": {
"default": 0,
"required": true,
"type": "integer",
"description": "Users with more than 10 devices in this hierarchy.",
"title": "Users with more than 10 Devices"
},
"voss_phone_servers": {
"default": 0,
"required": true,
"type": "integer",
"description": "Voss Phone Server license count for this hierarchy.",
"title": "Voss Phone Servers"
},
"ms_exchange_users": {
"default": 0,
"required": true,
"type": "integer",
"description": "The MS Exchange user count for this hierarchy.",
"title": "MS Exchange Users"
}
},
"schema_version": "1.1"
}
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/LicenseAuditCounts; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/LicenseAuditCounts/export/ |
|
{ "hrefs":["/api/data/LicenseAuditCounts/[pkid1]", "/api/data/LicenseAuditCounts/[pkid2]",...]}} |
For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
The XLSX format can be used to bulk load instances of data/LicenseAuditCounts and the JSON format can be used to import instances of data/LicenseAuditCounts.
GET http://[host-proxy]/api/data/LicenseAuditCounts/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/LicenseAuditCounts/ |
|
The data/LicenseAuditCounts schema and all instances as JSON. |
(The list will return 0 to 3 data/LicenseAuditCounts instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"move",
"transform",
"add",
"export",
"migration",
"bulk_update_form"
],
"pagination": {
"direction": "asc",
"order_by": "timestamp",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/data/LicenseAuditCounts/?skip=0&limit=3&order_by=timestamp&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 3
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "1.1",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/LicenseAuditCounts/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/data/LicenseAuditCounts/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/LicenseAuditCounts/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/LicenseAuditCounts",
"model_specific_actions": [
"export",
"help",
"list",
"get"
],
"summary_attrs": [
{
"name": "timestamp",
"title": "Timestamp"
},
{
"name": "user_licenses",
"title": "User Licenses"
},
{
"name": "users_with_more_than_10_devices",
"title": "Users with more than 10 Devices"
},
{
"name": "cisco_and_ms_integrated_services",
"title": "Cisco and MS Integrated Services"
},
{
"name": "standalone_devices",
"title": "Standalone Devices"
},
{
"name": "meeting_rooms",
"title": "Meeting Rooms"
},
{
"name": "voss_phone_servers",
"title": "Voss Phone Servers"
},
{
"name": "sites",
"title": "Sites"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": [
{
"pkid": "65e034a0377c80caae85cbaa",
"meta": {
"tags": [],
"cached": true,
"title": "2024-02-29T13:11:34.641Z",
"business_key": {},
"schema_version": "1.1",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "65e034a0377c80caae85cbaa",
"href": "/api/data/LicenseAuditCounts/65e034a0377c80caae85cbaa/"
}
],
"parent": [
{
"pkid": "6130d69ae04a4a0015a93bc6",
"href": "/api/data/HierarchyNode/6130d69ae04a4a0015a93bc6"
}
],
"foreign_key": []
},
"actions": [
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/LicenseAuditCounts/65e034a0377c80caae85cbaa/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/LicenseAuditCounts/65e034a0377c80caae85cbaa/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/LicenseAuditCounts/65e034a0377c80caae85cbaa/help",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/LicenseAuditCounts",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"6130d69ae04a4a0015a93bc6",
"65e034a0377c80caae85cbaa"
],
"summary_attrs": [
{
"name": "timestamp",
"title": "Timestamp"
},
{
"name": "user_licenses",
"title": "User Licenses"
},
{
"name": "users_with_more_than_10_devices",
"title": "Users with more than 10 Devices"
},
{
"name": "cisco_and_ms_integrated_services",
"title": "Cisco and MS Integrated Services"
},
{
"name": "standalone_devices",
"title": "Standalone Devices"
},
{
"name": "meeting_rooms",
"title": "Meeting Rooms"
},
{
"name": "voss_phone_servers",
"title": "Voss Phone Servers"
},
{
"name": "sites",
"title": "Sites"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"customer": "AAAGlobal",
"ms_teams_voice_users": 0,
"reseller": "CS-NB",
"customer_pkid": "6130d69ae04a4a0015a93bc6",
"pkid": "65e034a0377c80caae85cbab",
"timestamp": "2024-02-29T13:11:34.641Z",
"msol_users": 0,
"provider": "CS-P",
"cisco_and_ms_integrated_services": 0,
"sites": 3,
"user_licenses": 0,
"standalone_devices": 0,
"meeting_rooms": 0,
"users_with_more_than_10_devices": 0,
"voss_phone_servers": 0,
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"ms_exchange_users": 0,
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
},
{
"pkid": "65e0828d92340f8627d49f1e",
"meta": {
"tags": [],
"cached": true,
"title": "2024-02-29T13:11:34.641Z",
"business_key": {},
"schema_version": "1.1",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "65e0828d92340f8627d49f1e",
"href": "/api/data/LicenseAuditCounts/65e0828d92340f8627d49f1e/"
}
],
"parent": [
{
"pkid": "65e06c5b6fd4534903e06868",
"href": "/api/data/HierarchyNode/65e06c5b6fd4534903e06868"
}
],
"foreign_key": []
},
"actions": [
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/LicenseAuditCounts/65e0828d92340f8627d49f1e/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/data/LicenseAuditCounts/65e0828d92340f8627d49f1e/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/data/LicenseAuditCounts/65e0828d92340f8627d49f1e/help",
"title": "Help",
"class": "help",
"method": "GET"
}
}
],
"model_type": "data/LicenseAuditCounts",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"65e06c5b6fd4534903e06868",
"65e0828d92340f8627d49f1e"
],
"summary_attrs": [
{
"name": "timestamp",
"title": "Timestamp"
},
{
"name": "user_licenses",
"title": "User Licenses"
},
{
"name": "users_with_more_than_10_devices",
"title": "Users with more than 10 Devices"
},
{
"name": "cisco_and_ms_integrated_services",
"title": "Cisco and MS Integrated Services"
},
{
"name": "standalone_devices",
"title": "Standalone Devices"
},
{
"name": "meeting_rooms",
"title": "Meeting Rooms"
},
{
"name": "voss_phone_servers",
"title": "Voss Phone Servers"
},
{
"name": "sites",
"title": "Sites"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"customer": "TaurCom",
"ms_teams_voice_users": 13,
"reseller": "CS-NB",
"customer_pkid": "65e06c5b6fd4534903e06868",
"pkid": "65e0828d92340f8627d49f1f",
"timestamp": "2024-02-29T13:11:34.641Z",
"msol_users": 142,
"provider": "CS-P",
"sites": 4,
"cisco_and_ms_integrated_services": 0,
"user_licenses": 25,
"standalone_devices": 0,
"meeting_rooms": 0,
"users_with_more_than_10_devices": 0,
"voss_phone_servers": 0,
"hierarchy_friendly_name": "TaurCom (Customer)",
"ms_exchange_users": 12,
"hierarchy_path": "sys.hcs.CS-P.CS-NB.TaurCom"
}
},
{
"pkid": "65e0349f377c80caae85cba4",
"meta": {
"tags": [],
"cached": true,
"title": "2024-02-29T13:11:34.641Z",
"business_key": {},
"schema_version": "1.1",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "65e0349f377c80caae85cba4",
"href": "/api/data/LicenseAuditCounts/65e0349f377c80caae85cba4/"
}
],
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"foreign_key": []
},
"actions": [
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/data/LicenseAuditCounts/65e0349f377c80caae85cba4/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/data/LicenseAuditCounts/65e0349f377c80caae85cba4/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/data/LicenseAuditCounts/65e0349f377c80caae85cba4/help",
"class": "help",
"title": "Help"
}
}
],
"model_type": "data/LicenseAuditCounts",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"65e0349f377c80caae85cba4"
],
"summary_attrs": [
{
"name": "timestamp",
"title": "Timestamp"
},
{
"name": "user_licenses",
"title": "User Licenses"
},
{
"name": "users_with_more_than_10_devices",
"title": "Users with more than 10 Devices"
},
{
"name": "cisco_and_ms_integrated_services",
"title": "Cisco and MS Integrated Services"
},
{
"name": "standalone_devices",
"title": "Standalone Devices"
},
{
"name": "meeting_rooms",
"title": "Meeting Rooms"
},
{
"name": "voss_phone_servers",
"title": "Voss Phone Servers"
},
{
"name": "sites",
"title": "Sites"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"customer": "AB_Group",
"ms_teams_voice_users": 0,
"reseller": "CS-AB",
"customer_pkid": "5f3ae552ce894e00120537fa",
"pkid": "65e0349f377c80caae85cba5",
"timestamp": "2024-02-29T13:11:34.641Z",
"msol_users": 0,
"provider": "CS-P",
"cisco_and_ms_integrated_services": 0,
"sites": 15,
"user_licenses": 22,
"standalone_devices": 52,
"meeting_rooms": 0,
"users_with_more_than_10_devices": 0,
"voss_phone_servers": 0,
"hierarchy_friendly_name": "AB_Group (Customer)",
"ms_exchange_users": 0,
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
}
}
]
}
(Show the first instance)
{
"pkid": "65e034a0377c80caae85cbaa",
"meta": {
"tags": [],
"cached": false,
"title": "2024-02-29T13:11:34.641Z",
"business_key": {},
"schema_version": "1.1",
"references": {
"parent": [
{
"pkid": "6130d69ae04a4a0015a93bc6",
"href": "/api/data/HierarchyNode/6130d69ae04a4a0015a93bc6"
}
],
"self": [
{
"pkid": "65e034a0377c80caae85cbaa",
"href": "/api/data/LicenseAuditCounts/65e034a0377c80caae85cbaa/"
}
],
"foreign_key": [],
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"actions": [
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/LicenseAuditCounts/65e034a0377c80caae85cbaa/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/LicenseAuditCounts/65e034a0377c80caae85cbaa/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/LicenseAuditCounts/65e034a0377c80caae85cbaa/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/LicenseAuditCounts",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"6130d69ae04a4a0015a93bc6",
"65e034a0377c80caae85cbaa"
],
"summary_attrs": [
{
"name": "timestamp",
"title": "Timestamp"
},
{
"name": "user_licenses",
"title": "User Licenses"
},
{
"name": "users_with_more_than_10_devices",
"title": "Users with more than 10 Devices"
},
{
"name": "cisco_and_ms_integrated_services",
"title": "Cisco and MS Integrated Services"
},
{
"name": "standalone_devices",
"title": "Standalone Devices"
},
{
"name": "meeting_rooms",
"title": "Meeting Rooms"
},
{
"name": "voss_phone_servers",
"title": "Voss Phone Servers"
},
{
"name": "sites",
"title": "Sites"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"customer": "AAAGlobal",
"ms_teams_voice_users": 0,
"reseller": "CS-NB",
"customer_pkid": "6130d69ae04a4a0015a93bc6",
"pkid": "65e034a0377c80caae85cbab",
"timestamp": "2024-02-29T13:11:34.641Z",
"msol_users": 0,
"meeting_rooms": 0,
"sites": 3,
"cisco_and_ms_integrated_services": 0,
"user_licenses": 0,
"standalone_devices": 0,
"provider": "CS-P",
"users_with_more_than_10_devices": 0,
"voss_phone_servers": 0,
"ms_exchange_users": 0
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/LicenseAuditCounts. | GET | /api/data/LicenseAuditCounts/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/LicenseAuditCounts as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of data/LicenseAuditCounts; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/LicenseAuditCounts/[pkid]/export |
|
The response is an attachment. Refer to the list below. |
For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=json, the response is a time stamped zip file of data in JSON and a response format:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
The XLSX format can be used to bulk load instances of data/LicenseAuditCounts and the JSON format can be used to import instances of data/LicenseAuditCounts.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/LicenseAuditCounts/[pkid] | hierarchy=[hierarchy] | The data/LicenseAuditCounts instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/LicenseAuditCounts/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/LicenseAuditCounts. |