Trigger warranty scan for managed computers

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

Initiates a bulk warranty scan for managed computers. Fetches the latest warranty information from configured vendors.

Request URL

https://{serverurl}/dcapi/inventory/initiateWarrantyScan

Scope

DesktopCentralCloud.Inventory.CREATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/initiateWarrantyScanDetails.v1+jsonapplication/initiateWarrantyScanDetails.v1+jsonCopied!
AcceptstringMandatory
application/initiateWarrantyScanStatus.v1+jsonapplication/initiateWarrantyScanStatus.v1+jsonCopied!

- Request Body

application/json
JSON Object
Hide Sub-Attributes
scanTypestringMandatory

Scan target. 0 - All devices, 1 - Expired devices only, 2 - Soon-to-expire devices only.

vendorIDlongOptional

Restricts scan to a specific vendor. Omit to scan across all configured vendors. 1 - Dell, 2 - Lenovo, 3 - Toshiba, 4 - HP

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomains/dcapi/inventory/initiateWarrantyScan \
  --header 'Accept: application/initiateWarrantyScanStatus.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/initiateWarrantyScanDetails.v1+json' \
  --data '{"scanType":0}'

Sample Request Body

Scan all devices for any vendor

Copied!
  {
    "scanType": 0
  }
                
Show full

Scan only expired devices for a specific vendor

Copied!
  {
    "vendorID": 1,
    "scanType": 1
  }
                
Show full

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
statusstring

Result - Success or Failure

statusMessagestring

Human-readable result message

- HTTP code 401

Response Body - application/json
JSON Object
Hide Sub-Attributes
error_codestring

UAC_UNAUTHORIZED - user lacks the required uem-roles or credentials are missing

error_descriptionstring

Authentication or authorization failure reason

- 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 Response Codes

200HTTP code
401HTTP code
500HTTP code

Sample Response: HTTP 200

Bulk scan initiated

Copied!
  {
    "statusMessage": "Warranty scan has been initiated successfully.",
    "status": "success"
  }
                
Show full

Sample Response: HTTP 401

Missing credentials

Copied!
  {
    "error_description": "Unauthorized access",
    "error_code": "UAC_UNAUTHORIZED"
  }
                
Show full

Sample Response: HTTP 500

Server error

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

Duration: 1 minute | Threshold: 30 | 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.