Retrieve software metering rules

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Returns the list of software metering rules configured in the system, including app definition details and usage statistics

Request URL

https://{serverurl}/dcapi/inventory/viewData/swMeteringSummary

Scope

DesktopCentralCloud.Inventory.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/InventoryMobileAPI.v1+jsonapplication/InventoryMobileAPI.v1+jsonCopied!

- Query Parameters

toolIDstringMandatory

Set value as 7771

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url 'https://appdomain/dcapi/inventory/viewData/swMeteringSummary?toolID=7771' \
  --header 'Accept: application/InventoryMobileAPI.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'
Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON object
Hide Sub-Attributes
metadataJSON object

Pagination metadata

Show Sub-Attributes
limitstring

Number of items returned per page

pagestring

Current page number in paginated response

totalRecordsstring

Total number of records matching the query

messageResponseJSON array

Array of software metering rule objects

Show Sub-Attributes
JSON object
Show Sub-Attributes
original_file_name_transformstring

Original file name display value

file_versionstring

File version

comments_transformstring

Comments display value

product_name_transformstring

Product name display value

added_timestring

Rule added time as epoch timestamp

modified_time_transformstring

Modified time display value

os_platform_transformstring

OS platform display value

swm_discovered_countstring

Number of computers where software was discovered

app_definition_statusstring

App definition enabled status

modified_timestring

Modified time as epoch timestamp

added_bystring

User who added the rule

original_file_namestring

Original file name

file_version_transformstring

File version display value

commentsstring

Comments

modified_by_transformstring

Modified by user display value

file_namestring

Executable file name

os_platformstring

OS platform code

total_run_timestring

Total run time in seconds

definition_name_transformstring

Definition name display value

added_by_transformstring

Added by user display value

product_namestring

Product name

file_name_transformstring

File name display value

invswmeteringrulessummaryapp_definition_idstring

Metering rules summary app definition ID

total_run_countstring

Total run count

definition_namestring

App definition name

modified_bystring

User who last modified the rule

app_definition_idstring

App definition identifier

added_time_transformstring

Added time display value

customer_idstring

Customer identifier

totalPagesstring

Total number of pages

LinksJSON object

Pagination links

Show Sub-Attributes
nextstring

URL to the next page of results, null if last page

prevstring

URL to the previous page of results, null if first page

statusstring

Response status - success

- HTTP code 500

Response Body - application/json

JSON object
Hide Sub-Attributes
error_codestring

INTERNAL_ERROR - unexpected exception in the service layer

error_descriptionstring

Internal server error message

Possible HTTP Status Codes

200HTTP code
500HTTP code

Sample Response: HTTP 200

Software metering rules

Copied!
  {
    "metadata": {
      "limit": 25,
      "page": 1
    },
    "totalRecords": "2",
    "messageResponse": [
      {
        "original_file_name_transform": "--",
        "file_version": "",
        "comments_transform": "--",
        "product_name_transform": "--",
        "added_time": "1778827877323",
        "modified_time_transform": "May 15, 2026 12:21 PM",
        "os_platform_transform": "Windows",
        "swm_discovered_count": "1",
        "app_definition_status": "true",
        "modified_time": "1778827877323",
        "added_by": "SampleUser",
        "original_file_name": "",
        "file_version_transform": "--",
        "comments": "",
        "modified_by_transform": "SampleUser",
        "file_name": "sampleapp.exe",
        "os_platform": "1",
        "total_run_time": "145540",
        "definition_name_transform": "Sample App",
        "added_by_transform": "SampleUser",
        "product_name": "",
        "file_name_transform": "sampleapp.exe",
        "invswmeteringrulessummaryapp_definition_id": "1",
        "total_run_count": "726",
        "definition_name": "Sample App",
        "modified_by": "SampleUser",
        "app_definition_id": "1",
        "added_time_transform": "May 15, 2026 12:21 PM",
        "customer_id": "1"
      }
    ],
    "totalPages": 1,
    "Links": {
      "next": null,
      "prev": null
    },
    "status": "success"
  }
                
Show full

Sample Response: HTTP 500

Server error

Copied!
  {
    "error_description": "Internal server error",
    "error_code": "INTERNAL_ERROR"
  }
                
Show full

Duration: 1 minute | Threshold: 120 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.