Create Subscription Group¶

Create the subscription group.

Request Format¶

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

Request Parameters (URI)¶

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 Organization ID>>

Request Parameters (Body)¶

Request parameters (Body)¶
Name	Required or not	Data type	Description
subscribeGroupId	True	String	Subscription group ID. It must begin with DATASVC.SUBALL. or DATASVC.SUB.. Supports upper- and lower-case letters, numbers, underline (_), period (.) and hyphen (-). No more than 60 bytes.
enable	False	Boolean	Whether to enable the subscription group.
subscribeAll	False	Boolean	Whether to subscribe to all the measurement points. If the value is `True` , subscribeGroupId must start with `DATASVC.SUBALL.` . If the value is `False` , subscribeGroupId must start with `DATASVC.SUB.`.
subscribeModelList	False	Array	List of the subscribed models, where the list element is the model identifier.
subscribeProductList	False	Array	List of the subscribed products, where the list element is the product key.
subscribeAssetList	False	Array	List of the subscribed assets, where the list element is the asset ID.
subscribeDeviceList	False	Array	List of the subscribed devices, where the structure of the list element is in the table below.
subscribeModelPointList	False	Array	Measurement points of the subscribed models, where the structure of the list element is in the table below.
subscribePointList	False	Array	List of the measurement point data of the subscribed devices, where the structure of the list element is in the table below.

subscribeDeviceList structure¶
Name	Required or not	Data type	Description
productKey	False	String	Product key of the device
deviceKey	False	String	Device key of the device

subscribeModelPointList structure¶
Name	Required or not	Data type	Description
modelId	False	String	Identifier of the model that the device belongs to
pointList	False	Array	List of point IDs

subscribePointList structure¶
Name	Required or not	Data type	Description
assetId	False	String	Asset ID of the device asset that the measurement point belongs to, which is used to specify a device asset
productKey	False	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	False	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	False	Array	List of point IDs

Note

In the subscribePointList object, you may use either assetId or the combination of productKey and deviceKey to identify a device asset. If all the three parameters exist in the subscribePointList, the assetId will be used to identify the device.

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 ID
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 ID
subscribeDeviceList	Array	List of the subscribed devices, where the structure of the list element is in the table below.
data.subscribeModelPointList	Array	List of the measurement points associated to the subscribed models, where the structure of the list element is in the table below.
data.subscribePointList	Array	List of the points associated to the subscribed devices, where the structure of the list element is in the table below.

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

subscribeModelPointList object¶
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

Note

In the subscribePointList object, you may use either `assetId or the combination of productKey and deviceKey to identify a device asset. If all the three parameters exist in the subscribePointList, the assetId will be used to identify the device.

Samples¶

Request Sample¶

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

{
   "subscribeGroupId":"DATASVC.SUB.group1",
   "enable":true,
   "persistent":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"
         ]
      }
   ]
}

Response Sample¶

{
   "status":0,
   "msg":"Success",
   "submsg":null,
   "data":{
      "id":"dsfasdfdasfdsaf",
      "subscribeGroupId":"DATASVC.SUB.group1",
      "enable":true,
      "persistent":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"
            ]
         }
      ]
   }
}