Begin Request Arguments

A begin request can include the following arguments.

Argument	Type	Description
step	string	(Required) Must be set to begin.
respond	string	(Optional) A topic where the response object is expected. The response topic is allocated by the initiator (the CMS). 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. Example: "IzoT Net Export Tool 1.23.456@myServer.acme.com, myDatabase"
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. See option argument under Import Open for more details and an example.

Begin Response

When the begin request includes a response topic, the edge server publishes the response object to the requested respond topic when ready.

Parameter	Type	Description
step	string	(Required) The step from the corresponding request.
meta	any	(Optional) Meta data from the corresponding request, if any.
error	string	(Optional) 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.

Parameter

Type

Description

step

string

(Required) The step from the corresponding request.