Create Control Channel¶
Create the control channel.
Request Format¶
POST http://{apigw-address}/dataService/controlChannels?orgId={}
Request Parameters (URI)¶
Name | Location (Path/Query) | Required or not | Data type | Description |
---|---|---|---|---|
orgId | Query | Yes | String | Organization ID which the asset belongs to. How to get orgId>> |
Request Parameters (Body)¶
Name | Required or not | Data type | Description |
---|---|---|---|
controlChannelId | Yes | String | Control channel ID. Supports upper and lower cases letters, numbers (0-9), underline (_), English period (.) and hyphen (-). No more than 60 bytes. |
desc | No | String | 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 |
---|---|---|
id | String | Internal data ID |
controlChannelId | String | Control channel ID |
Samples¶
Request Sample¶
POST http://{apigw-address}/dataService/controlChannels?orgId=o15434988531231
{
"controlChannelId":"DATASVC.CONTROL.controlChannelId1",
"desc":"desc"
}
Response Sample¶
{
"status":0,
"msg":"Success",
"submsg":null,
"data":{
"id":"dsfasdfdasfdsaf",
"controlChannelId":"DATASVC.CONTROL.controlChannelId1",
"desc":"desc"
}
}