- Get the authorization token of the IEM user by calling IEM's '/login/direct' API.
- Get the application ID of the Flow Creator or Flow Creator(arm64) app by calling IEM's '/applications' API.Ensure that Flow Creator or Flow Creator(arm64) app needed for configuration is copied in the IEM catalog.
- Get the device ID(s) of all the IE device(s) onboarded to the IEM by calling IEM's '/devices' GET API.Ensure that Flow Creator or Flow Creator(arm64) app needed for configuration is installed in the IE device(s).You can use IEM's 'devices/installed-apps' to check if Flow Creator or Flow Creator(arm64) app is installed in a IE device.
-
Get a batch ID by calling IEM's '/batches' POST API & pass the request body in multipart/form-data format.In params pass the 'appid' value from step 2 above & 'operation' value as 'installApplication'. Only devices array is required in the request body & pass any one device ID from step 3.
-
Call the '/provision' API to initialize the configurator API server by using the batch ID from step 4.
-
Upload a flow, file, or node to the configurator API server.For flow: Upload a flow file by calling the '/flows/{fileName}' API after providing the flow jsonFor file: Upload a file by calling the '/files/{fileName}' API after attaching the valid file.For node: Upload a .tgz file by calling the '/custom-nodes/{fileName}' API after attaching the valid file.
-
Call the '/deploy' API. Pass one or many device ID(s) from step 3 into the request body. This will deploy the configurations of your choice from the configurator API server to the selected IE device(s), by creating a job for each of the IE device.
-
To track a job in IED, call the status API '/job/status/{type}' to check the progress of a job on a IE device. Wait until the job status returned is 'COMPLETED'
- To check device events for the app, call '/devices/status/connections' to get all events from the IE device for the Flow Creator application, such as the deployment status of the last flow, file, or node deployed using the '/deploy' API, and any error messages. Latest events will be received only after the job has been completed on the IE device(s).