Get Subscription Group¶

Get the subscription group details.

Request Format¶

GET http://{apigw-address}/dataService/subscribeGroups/{subscribeGroupId}?orgId={}

Request Parameters (URI)¶

Request parameters (URI)¶
Name	Location (Path/Query)	Required or not	Data type	Description
subscribeGroupId	Path	Yes	String	Subscription group ID
orgId	Query	Yes	String	Organization ID which the asset belongs to. How to get Organization ID>>

Note

Replace {subscribeGroupId} with the subscription group ID instead of using “subscribeGroupId= Subscription group 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	Internal data ID
subscribeGroupId	String	Subscription group ID
enable	Boolean	Whether to enable the subscription group
subscribeAll	Boolean	Whether the subscription group subscribes to all the measurement points
subscribeModelList	Array	List of the subscribed models, where the list element is the model identifier
subscribeProductList	Array	List of the subscribed products, where the list element is the Product Key
subscribeAssetList	Array	List of the subscribed assets, where the list element is the asset identifier
subscribeDeviceList	Array	List of the subscribed devices, where the list element is a JSON object. The structure of the object is in the table below.
subscribeModelPointList	Array	List of the measurement points associated to the subscribed models, where the list element is a JSON object. The structure of the object is in the table below.
subscribePointList	Array	List of the points associated to the subscribed devices, where the list element is a JSON object. The structure of the object is in the table below.

subscribeDeviceList structure¶
Name	Data type	Description
productKey	String	Product key of the subscribed device
deviceKey	String	Device key of the subscribed device

subscribeModelPointList structure¶
Name	Data type	Description
modelId	String	ID of the model that the device belongs to
pointList	Array	List of point IDs

subscribePointList structure¶
Name	Required or not	Description
assetId	String	Asset ID of the device asset that the measurement point belongs to, which is used to specify a device asset
productKey	String	Product key of the product that the measurement point belongs to, which is used to specify a device asset along with the `deviceKey`
deviceKey	String	Device key of the product that the measurement point belongs to, which is used to specify a device asset along with the `productKey`
pointList	Array	List of measurement point IDs

Samples¶

Request Sample¶

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

Response Sample¶

{
   "status":0,
   "msg":"Success",
   "submsg":null,
   "data":{
      "id":"dsafdasfdsafd",
      "subscribeGroupId":"DATASVC.SUB.group1",
      "enable":true,
      "subscribeAll":false,
      "subscribeModelList":[
         "model1",
         "model2",
         "model3"
      ],
      "subscribeProductList":[
         "product1",
         "product2",
         "product3"
      ],
      "subscribeAssetList":[
         "asset1",
         "asset2",
         "asset3"
      ],
      "subscribeDeviceList":[
         {
            "productKey":"productKey1",
            "deviceKey":"deviceKey1"
         },
         {
            "productKey":"productKey2",
            "deviceKey":"deviceKey2"
         }
      ],
      "subscribeModelPointList":[
         {
            "modelId":"model1",
            "pointList":[
               "point1",
               "point2",
               "point3"
            ]
         },
         {
            "modelId":"model2",
            "pointList":[
               "point1",
               "point2",
               "point3"
            ]
         }
      ],
      "subscribePointList":[
         {
            "assetId":"asset10",
            "productKey":"productKey10",
            "deviceKey":"deviceKey10",
            "pointList":[
               "point1",
               "point2",
               "point3"
            ]
         },
         {
            "assetId":"",
            "productKey":"productKey11",
            "deviceKey":"deviceKey11",
            "pointList":[
               "point1",
               "point2",
               "point3"
            ]
         }
      ]
   }
}