Skip to end of metadata
Go to start of metadata

Scenario:

  1. Other kinds of Id information may be needed for API commands sent to GadgetKeeper
  2. These Ids can be be grouped into two categories, and are explained as follows:

Other Ids needed to interact with a "thing"

  1. Miscellaneous Ids that enable interactions with a "thing" include Connection Ids, Schedule Ids, and Trigger Ids
  2. A typical command would create/delete, set/get details, enable/disable, or start/stop the process or function
  3. These commands need a "Thing Id" and maybe another Id in order to perform the interaction
  4. The "Thing Id" is obtained as shown in Thing Id
  5. Other Ids are obtained as shown in Property Id, Method Id, Event Id, and API Keys
  6. The following procedure is an example of how to obtain an Id for a miscellaneous interaction with a "thing"

Procedure:

  1. In the "Things" tab, select the desired "thing" to open its tab
  2. Select the panel where the Id is located (Connections, Schedules, or Triggers)
  3. When the new tab opens, select the Connection, Schedule, or Trigger where the Id can be obtained
  4. Double click on the Id in the "Details" panel to select it, and then copy the Id

Note: A diagram for "Schedules" is shown, but this procedure is the same for "Connections" and "Triggers"


Ids associated with Data Types, Templates, and Products

  1. These Ids include Data Type Id, Template Id, Template version Id, Product Id, and Product serial number Id
  2. A typical command would either create/delete or set/get details of the chosen object
  3. Some of these commands may need a "Thing Id" and/or another Id to perform the interaction
  4. These Ids are obtained as explained in the previous section
  5. The following procedure is an example on how to obtain an Id for a template and/or a template version (the procedure is basically the same for the other Ids)

Procedure:

  1. Click "Templates" in the main menu to open a tab listing the current templates
  2. Select the desired template in this list to open its tab (the Template Id can be found in the "Information" section)
  3. Click "Versions" to open the listing of template versions
  4. Select the desired version to show its details
  5. Double click on the Id in the "Details" panel to select it, and then copy the version Id

The procedure outlined here can also be use used to obtain a Product Id and/or a Product serial number


 

       7. The Id for "Data Types" is obtained in a slightly different way
       8. Click "Data Types" in the main menu to open a tab listing the data types
       9. Select the desired data type to open its dialog box as shown below
     10. The Id for Data Types is in the form "Package.Name"
     11.  In this instance, the Id is "remote device.Value" (a period must be inserted)
     12. The Id must be copied and structured in this format before it's pasted in the API command


 

 

 

  • No labels