Splits and parses a device instance path Splits and parses a device instance path for UI/workflow usage.
Request URL https://{server-hostname}:8383/dcapi/device/splitinstancepath
Scope
Header Authorization: d92d4xxxxxxxxxxxxx15f52
Request Parameters - Request Headers Content-Type string Mandatory
- Request Body application/json JSON object
Hide Sub-Attributes parentInstancePath string Optional
Parent device instance path
deviceInstancePath string Optional
Full device instance path to split
Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
--url https://appdomain/dcapi/device/splitinstancepath \
--header 'Authorization: d92d4xxxxxxxxxxxxx15f52' \
--header 'Content-Type: application/json' \
--data '{"deviceTypeId":1,"deviceInstancePath":"USB\\VID_0781&PID_55AB\\04015160","parentInstancePath":"USB\\VID_0781&PID_55AB"}'import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;
public class Main {
public static void main(String[] args) {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://appdomain/dcapi/device/splitinstancepath"))
.header("Content-Type", "application/json")
.header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
.method("POST", HttpRequest.BodyPublishers.ofString("{\"deviceTypeId\":1,\"deviceInstancePath\":\"USB\\\\VID_0781&PID_55AB\\\\04015160\",\"parentInstancePath\":\"USB\\\\VID_0781&PID_55AB\"}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
}
import http.client
conn = http.client.HTTPSConnection("appdomain")
payload = "{\"deviceTypeId\":1,\"deviceInstancePath\":\"USB\\\\VID_0781&PID_55AB\\\\04015160\",\"parentInstancePath\":\"USB\\\\VID_0781&PID_55AB\"}"
headers = {
'Content-Type': "application/json",
'Authorization': " d92d4xxxxxxxxxxxxx15f52"
}
conn.request("POST", "/dcapi/device/splitinstancepath", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
headersMap = Map();
headersMap.put("Content-Type", "application/json");
headersMap.put("Accept", "application/json");
data=Map();
data.put("parentInstancePath","value");
data.put("deviceInstancePath","value");
data.put("deviceTypeId","1");
response = invokeUrl
[
url: "https://appDomain/dcapi/device/splitinstancepath"
type: POST
headers: headersMap
body: data
connection: connection_name
]
info response;
$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/dcapi/device/splitinstancepath' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"deviceTypeId":1,"deviceInstancePath":"USB\\VID_0781&PID_55AB\\04015160","parentInstancePath":"USB\\VID_0781&PID_55AB"}'▼ Show full
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 vendorHexID string
Parsed vendor hexadecimal identifier
productHexID string
Parsed product hexadecimal identifier
serialNo string
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 errorCode string
Error code identifying the type of error
errorMsg string
Human-readable error message
- HTTP code 500 Response Body - application/json JSON object
Hide Sub-Attributes errorCode string
Error code identifying the type of error
errorMsg string
Human-readable error message
Possible Response Codes 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 {
"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.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.