step

string

(Required) Must be set to open.

respond

string

(Optional) A topic where the response object is expected. The response topic is allocated by the tool that publishes the import action request. It must be within the feedback channel for this edge server to allow communication across bridged message brokers.

Example:
glp/0/{SID}/fb/=cms/import/response

meta

any

(Optional) If provided, the meta data is returned with the response.

origin

string

(Optional) A human-readable description of the initiator. There is no fixed format but the origin should be described to allow for meaningful error diagnosis.  

protocols

list of strings

(Required) A list of affected edge protocols using standard IAP/MP protocol identifiers; "lon" for LonWorks.  

option

object

(Optional) option is either undefined, or an object whose keys equal an IAP/MQ protocol identifier. The value of a given key is protocol-specific and subject to agreement between the edge protocol aware export tool that generates these import action invocations and the targeted protocol engine. For example, a LonTalk export tool and a LonTalk engine might agree to support this option object with the import.open request:

Example:

{
   lon: {
       domainId: “123400”,
       domainLength: 3
  }
}

clear

Boolean

(Optional) Defaults to False.

When set to true (or not provided), the "open" step resets databases and the state of the affected edge protocol processors before preparing each for importing. 

Setting clear to false validates preconditions and prepares the affected edge protocol processors for incremental importing.

step

string

The step from the corresponding request.

meta

any

meta data from the corresponding request, if any. 

error

string

A human-readable error description, undefined if no error occurred. Errors not in direct relation to this request are reported through the IAP/MQ event channel, captured by the IAP/REST engine and reported with the IAP/REST import responses.