Create virtual device
- Print
- PDF
Create virtual device
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Summary
Creates a virtual device.
Request
Request URL
POST {CLOUD_IOT_CORE_API_URL}/devices
Content-Type: application/json; charset=utf-8
x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}
Request body
{
"device" : {
"name": "string",
"description": "string"
},
"deviceProperties":{
"createUpdateList" : [
{
"key": "string",
"value": "string"
}
]
}
}
| Category | Required status | Type | Restrictions | Description |
|---|---|---|---|---|
| name | Yes | string | Less than 128 characters. Only lower and upper English letters, numbers, -, and _ are allowed. | Virtual device name |
| description | Yes | string | Up to 128 characters are allowed. The characters &, <, >, ", and ' aren't allowed. | Virtual device description |
| deviceProperties.createUpdateList[].key | Yes | string | Less than 128 characters. Only lower and upper English letters, numbers, -, and _ are allowed. | Virtual device property Key. Find the same key and modify the information. If an existing saved key is not in the request body, it will be deleted. |
| deviceProperties.createUpdateList[].value | No | string | Less than 512 characters. 영Only lower and upper English letters, numbers, -, and _ are allowed. | Virtual device property Value |
Response
Response body
{
"status": "string",
"body": {
"device": {
"name": "string",
"description": "string",
"modifyTime": "localDateTime",
"registerTime": "localDateTime"
},
"deviceProperties": {
"createUpdateList": [
{
"key": "string",
"value": "string",
"modifyTime": "localDateTime",
"registerTime": "localDateTime"
}
]
}
}
}
| Category | Type | Description |
|---|---|---|
| status | string | Indicates whether response was successful |
| body.name | string | Virtual device name |
| body.description | string | Virtual device description |
| body.modifyTime | localDateTime | Virtual device last modified date |
| body.registerTime | localDateTime | Virtual device creation date |
| body.deviceProperties.createUpdateList[].key | string | Virtual device property Key |
| body.deviceProperties.createUpdateList[].value | string | Virtual device property Value |
| body.deviceProperties.createUpdateList[].modifyTime | localDateTime | Virtual device property last modified date |
| body.deviceProperties.createUpdateList[].registerTime | localDateTime | Virtual device property creation date |
Example
{
"status": "SUCCESS",
"body": {
"device": {
"name": "bulb",
"description": "bulb in living room",
"modifyTime": "2020-09-25 14:15:25",
"registerTime": "2020-09-25 14:15:25"
},
"deviceProperties": {
"createUpdateList": [
{
"key": "lux",
"value": "2000",
"modifyTime": "2020-09-25 14:15:25",
"registerTime": "2020-09-25 14:15:25"
},
{
"key": "ampere",
"value": "5",
"modifyTime": "2020-09-25 14:15:25",
"registerTime": "2020-09-25 14:15:25"
}
]
}
}
}
Was this article helpful?