DELETE_edgeDevices_{linkId}_config

DELETE /edgeDevices/{linkId}/config

This resource is used to selectively cancel an edge device configuration change to a specified linked edge device that is currently either processing or in queue, to be downloaded. For Gateway firmware version 1.51.22 and later, and all RC firmware versions.

NOTE: Transfers from the Gateway to the edge device from PUT /edgeDevices/{linkId}/config are sent to the edge device in 1024-byte segments. Because of the JSON body size limitation of 2k for PUT /edgeDevices/{linkId}/config if the Gateway has already started the JSON transfer to the edge device when this resource is requested, it is not probable that the message transfer will be able to be interrupted. This resource will be best utilized when the Gateway has queued the JSON transfer to the respective edge device. (i.e., if the Gateway is currently transferring a config to linkId 0004 and this resource is requested for linkId other than 0004, this resource will be most effective)

Authentication

Basic – unique credentials defined and accepted during setup.

Request

URI parameters:

Type: path parameter

linkId = linked edge device identifier, as defined in the *ENGAGE - JSON Data Structures document, section titled Gateway Edge Device Link List. For reader-controllers this is a constant dev00000.

Success Response

HTTP status code 200

The config download which was previously in progress has been canceled by the Gateway or the config download for the reader-controller has been canceled.

Response parameters:

Type: application/json

none

Error Response

HTTP status code 403

Config transfer cannot be canceled. Please see the following response options:

Response parameters:

Type: application/json