Get Control Channel

Get the control channel details.

Request Format

GET http://{apigw-address}/dataService/controlChannels/{controlChannelId}?orgId={}

Request Parameters (URI)

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

Response Parameters

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

data object

Name

Data type

Description

id

String

Internally defined data identifier

controlChannelId

String

Control channel ID

desc

String

Control channel description

Samples

Request Sample

GET http://{apigw-address}/dataService/controlChannels/{controlChannelId}?orgId=o15434988531231

Response Sample

{
   "status":0,
   "msg":"Success",
   "submsg":null,
   "data":{
      "id":"dsfasdfdasfdsaf",
      "controlChannelId":"DATASVC.CONTROL.controlChannelId1",
      "desc":"desc"
   }
}