Device Capabilities

Owned by Nina Cardillo
10-Jan-2024
5 min read


URI Definition

MethodURI and Fields
GET


/iap/devs/firmwareImgList

Returns a list of available firmware images for the specified device.

Query Parameter

Argument                        

Description                                                                                                                          

DID

(Required) ID of the device that is the target for the update.

The content type is multipart/form-data.

Example

https://localhost/iap/devs/firmwareImgList?deviceId=2


[                                                                                                                                      
   {
       "id": 551,
       "fileName": "LH-PM100E_6k.APB",
       "mimeType": {
           "primaryType": "application",
            "subType": "octet-stream",
            "parameters": {
               "empty": true,
               "names": {
               }
           },
           "baseType": "application/octet-stream"
       },
       "metafileHashtags": [
           {
               "id": 552,
               "hashtagId": 40,
               "name": "fileSize",
               "value": "8 KB"
           },
           {
               "id": 554,
               "hashtagId": 43,
               "name": "deviceType",
               "value": "LH-PM100E_S6k"
           },
           {
               "id": 553,
               "hashtagId": 39,
               "name": "firmwareImage",
               "value": "true"
           }
       ],
       "dataUrlPrefix": "data:application/octet-stream;base64,"
   }
]     

/iap/devs/lonmode

Returns the LON management mode: DMM (Device Management Mode) or IMM (Independent Management Mode).

Example

https://localhost/iap/devs/lonmode                                                     


{value: "DMM"}

PUT/iap/devs/provision

Performs provisioning operations on specified devices. Devices that don’t have this capability are skipped.

Request Payload:

[string, …]                                                                                                         

Example:

https://localhost/iap/devs/provision

Request Body:

["2","3"]                                                                                                            

/iap/devs/deprovision

Performs deprovisioning operations on specified devices. Devices that don’t have this capability are skipped.

Request Payload

[string, …]                                                                                                         

Example

https://localhost/iap/devs/deprovision

Request Body:

["2","3"]                                                                                                            

/iap/devs/{id}/demand

Sends an on-demand RTSM request to the specified device. When the RTSM message appears, any monitored datapoints will be published to the CMS.

Argument

Argument                        

Description                                                                                                                          

id

(Required) Device ID of the target device.

Example

https://localhost/iap/devs/2/demand                                                     

/iap/devs/{id}/replace

Replaces one device with another. This operation replaces the physical device connected to the CMS’ representation of the device, with another physical device specified with the UNID parameter.

Arguments

Argument                        

Description                                                                                                                          

UNID

[integers] ID of the replacement device.   Specified in the request payload.

id

(Required) ID of the device to be replaced.

Request Payload

{
value : [string]              // this is the UNID of the replacement device          
}

Example

https://localhost/iap/devs/3/replace                                                     

Request Body

{
"value":"00D07111EA6B"
}

/iap/devs/reset

Resets the specified collection of devices.

Request Payload

[string, …]                                                                                                          

Example

https://localhost/iap/devs/reset                                                            

Request Body

["2","3"]

/iap/devs/{id}/test

Tests specified device whether it is available at the moment. A null payload is required.

Argument

Argument                        

Description                                                                                                                          

id

(Required) ID of the device to be tested.

Example

https://localhost/iap/devs/2/test                                                            

/iap/devs/{id}/wink

Sends wink command to the specified device. A null payload is required.

Arguments

Argument                        

Description                                                                                                                          

id

(Required) ID of the device to receive the wink.

Example

https://localhost/iap/devs/2/wink                                                            

/iap/devs/load/{id}

Updates the firmware or file of the specified device. This method currently has the following limitations: only manifest files with an external link to image can be processed.

Arguments

Argument                        

Description                                                                                                                          

id

(Required) ID of the device to be updated.

Content Type

multipart/form-data.

Request Payload

Zip file containing the valid manifest file.

Example

https://localhost/iap/devs/load/2                                                            

Request Body

------WebKitFormBoundaryPV0P59KMDZGgMaBC

Content-Disposition: form-data; name="metafile"; filename="LH-PM100E_6k.APB"

Content-Type: application/octet-stream

------WebKitFormBoundaryPV0P59KMDZGgMaBC--

/iap/devs/loadWith/{fileId}/{devId}

Performs load action for the specified device with the specified file.

Arguments

Argument                        

Description                                                                                                                          

fileId

(Required) ID of the file in the CMS.

devId(Required) Device ID.

Example

https://localhost/iap/devs/loadWith/55/2                                                      
/iap/devs/loadAllWith/{fileId}

Performs load action for all devices with the specified file.

Arguments

Argument                        

Description                                                                                                                          

fileId

(Required) ID of the file in the CMS.

Example

https://localhost/iap/devs/loadAllWith/551                                                       
/iap/devs/bulkFirmwareUpdate/{deviceModel}

Updates firmware on all devices that meet the model criteria.

Arguments

Argument                        Description                                                                                                                          
deviceModel

(Required) The device model that is to be updated.

Content Type

multipart/form-data.

Required payload:

A file containing the firmware update image.

Example

https://localhost/iap/devs/bulkFirmwareUpdate/LH-PM100E_S6k                   
/iap/devs/lonmode/{mode}

Sends a switch Management Mode request to every LON device with SYSTEM_MANAGEMENT_DEVICE_PROGRAM_ID available for the current user. Updates the LON mode for corresponding root geozones.

Arguments

Argument                        

Description                                                                                                                          

mode

(Required) Specifies either DMM or IMM.    

Example

https://localhost/iap/devs/lonmode/IMM                                                             
/iap/devs/discover

Sends request to discover devices for all available edge servers.

Example

https://localhost/iap/devs/discover                                                                      
/iap/devs/{scId}/rebuild

Rebuilds the segment controller with the specified ID.

Arguments

Argument                        

Description                                                                                                                          

scId

(Required) ID of segment controller to be rebuilt..    

Example

https://localhost/iap/devs/1/rebuild                                                                      

Query Parameters

Optional query parameters can be used with your REST request.  Specifying queries is described under Queries and Parameters, Path Parameters, and Query Parameters.