# Splits and parses a device instance path

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

## Endpoint

**POST** `/dcapi/device/splitinstancepath`

## Request URL

`https://{server-hostname}:8383/dcapi/device/splitinstancepath`

## Scope

`DeviceControl.CREATE`

## Header

`Authorization: d92d4xxxxxxxxxxxxx15f52`

## Request Parameters

### Request Headers

- **Content-Type** (`string`, Mandatory): `application/json`

### Request Body

`application/json`

- JSON object
  - **parentInstancePath** (`string`, Optional): Parent device instance path
  - **deviceInstancePath** (`string`, Optional): Full device instance path to split
  - **deviceTypeId** (`long`, Optional): Device type identifier. Fetch from [Get Supported Devices](https://www.manageengine.com/products/desktop-central/help/api/onpremise/dcpget-supported-devices.html)

### Sample Request

```curl
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"}'
```

### Sample Request Body

Split a device instance path

```json
{
  "deviceTypeId": 1,
  "deviceInstancePath": "USB\\VID_0781&PID_55AB\\04015160",
  "parentInstancePath": "USB\\VID_0781&PID_55AB"
}
```

## Response Parameters

### HTTP Code 200

Response Body — `application/json`

- JSON object
  - **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
  - **errorCode** (`string`): Error code identifying the type of error
  - **errorMsg** (`string`): Human-readable error message

### HTTP Code 500

Response Body — `application/json`

- JSON object
  - **errorCode** (`string`): Error code identifying the type of error
  - **errorMsg** (`string`): Human-readable error message

## Possible Response Codes

- **200** — HTTP code
- **400** — HTTP code
- **500** — HTTP code

## Sample Responses

### HTTP 200

Split instance path response

```json
{
  "productHexID": "55AB",
  "vendorHexID": "0781",
  "serialNo": "04015160"
}
```

### HTTP 400

Bad request - missing parentInstancePath

```json
{
  "errorCode": "INCORRECT_REQUEST_DATA",
  "errorMsg": "parentInstancePath can't not be empty"
}
```

### HTTP 500

Internal server error

```json
{
  "errorCode": "INTERNAL_ERROR",
  "errorMsg": "Internal Server Error!"
}
```

## Rate Limit

![](https://www.zohowebstatic.com/sites/zweb/images/people/ico-help.png)

**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.