Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Use the wizard to create a configuration template for a LIBERO Gx

    • Select the correct type of LIBERO Gx (first three numbers of the serial number are of importance)

    • Fill in the wizard forms until the summary page is reached

    • Alt+Click on the “Buy and Start Sensor” button

      • A file download fill will appear

      • Save the file with a fitting name (e.g. LIBERO_GH_longlive_freezer.json)

  • Use the POST /api/v1/Templates endpoint to upload the contents of the saved configuration JSON file

    • Important: The configuration has to be jsonJSON-escaped. Do this programatically programmatically or use an online tool

    • The request object is described in the swagger uiUI

  • Optional: Use the GET /api/v1/Templates endpoint to list all available templates

...

  • Use the PUT /api/v1/Device/{deviceSerialNumber} endpoint to configure the devices

    • One call per device. Use , use a script to automate this process

    • Three possible payloads, as denoted by $type

      • Check the swagger ui UI for more information on the specific objects

      • DeviceConfigurationRequestByTemplateId and DeviceConfigurationRequestByTemplateName can be used to configure a device

        • Optional: provide metadata, see swagger ui UI for more information on placeholders

      • DeviceConfigurationRequestClearPending can be used to clear a pending configuration for devices that have not been paired to the organization yet

3.3 Version of the REST-

...

API

For the REST-API a versioning mechanism is implemented.

...