Splits and parses a device instance path

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

Splits and parses a device instance path for UI/workflow usage.

Request URL

https://{serverurl}/dcapi/device/splitinstancepath

Scope

DesktopCentralCloud.DeviceControl.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/jsonapplication/jsonCopied!

- Request Body

application/json
JSON Object
Hide Sub-Attributes
parentInstancePathstringOptional

Parent device instance path

deviceInstancePathstringOptional

Full device instance path to split

deviceTypeIdlongOptional

Device type identifier. Fetch from Get Supported Devices

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomains/dcapi/device/splitinstancepath \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{}'

Sample Request Body

Split a device instance path

Copied!
  {
    "deviceTypeId": 1,
    "deviceInstancePath": "USB\\VID_0781&PID_55AB\\04015160",
    "parentInstancePath": "USB\\VID_0781&PID_55AB"
  }
                
Show full

Response Parameters

- HTTP code 200

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

Parsed vendor hexadecimal identifier

productHexIDstring

Parsed product hexadecimal identifier

serialNostring

Parsed serial number. Falls back to parentInstancePath if serial number cannot be extracted

- HTTP code 400

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

Error code identifying the type of error

errorMsgstring

Human-readable error message

- HTTP code 500

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

Error code identifying the type of error

errorMsgstring

Human-readable error message

Possible Response Codes

200HTTP code
400HTTP code
500HTTP code

Sample Response: HTTP 200

Split instance path response

Copied!
  {
    "productHexID": "55AB",
    "vendorHexID": "0781",
    "serialNo": "04015160"
  }
                
Show full

Sample Response: HTTP 400

Bad request - missing parentInstancePath

Copied!
  {
    "errorCode": "INCORRECT_REQUEST_DATA",
    "errorMsg": "parentInstancePath can't not be empty"
  }
                
Show full

Sample Response: HTTP 500

Internal server error

Copied!
  {
    "errorCode": "INTERNAL_ERROR",
    "errorMsg": "Internal Server 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.