Update Control Channel¶
Update the control channel.
Request Format¶
PUT http://{apigw-address}/dataService/controlChannels/{controlChannelId}?orgId={}
Request Parameters (URI)¶
Name | Location (Path/Query) | Required or not | Data type | Description |
---|---|---|---|---|
controlChannelId | Path | Yes | String | Control channel ID |
orgId | Query | Yes | String | Organization ID which the asset belongs to. How to get Organization ID>> |
Note
Replace {controlChannelId} with the subscription group ID instead of using “controlChannelId= Control channel ID”.
Request Parameters (Body)¶
Name | Required or not | Data type | Description |
---|---|---|---|
controlChannelId | False | String | Control channel ID. Supports upper- and lower-case letters, numbers, underline (_), period (.) and hyphen (-). No more than 60 bytes. |
desc | False | String | Control channel description |
Response Parameters¶
Name | Data type | Description |
---|---|---|
status | Int | Status code |
msg | String | Response message |
submsg | String | Response sub-message |
data | Object | Response data object, the structure of which is in the table below |
Name | Data type | Description |
---|---|---|
controlChannelId | String | Control channel ID |
desc | String | Control channel description |
Samples¶
Request Sample¶
PUT http://{apigw-address}/dataService/controlChannels/{controlChannelId}?orgId=o15434988531231
{
"controlChannelId":"DATASVC.CONTROL.channel1",
"desc":"This is for control"
}
Response Sample¶
{
"status":0,
"msg":"Success",
"submsg":null,
"data":{
"controlChannelId":"DATASVC.CONTROL.channel1",
"desc":"This is for control"
}
}