Selector Options

The options endpoint is used to add some further help when users are entering a selector in a text entry control.

Just like the selector endpoint, it takes a query parameter that contains the selector you've written so far.

However, you usually call 'options' when your selector is already valid (ie. you're selecting one or more valid assets with the selector).

The 'options' then provide some hints and suggestions for where the user might want to go next with their selector, such as adding extra conditions, picking a specific asset from a set etc.

For example, if we has a finished selector Finish Oven (which translates to 'select the asset called Finish Oven'), a call to options would return…

 [
  [
      "Entire Asset",
      "Finish Oven",
      true
  ],
  [
      "Finish Oven.Equipment Tag",
      "Finish Oven.Equipment Tag",
      true
  ],
  [
      "Finish Oven.Speed - Maximum",
      "Finish Oven.Speed - Maximum",
      true
  ],
  [
      "Finish Oven.Tension - Actual",
      "Finish Oven.Tension - Actual",
      true
  ],
  [
      "Inside (Direct)",
      "Finish Oven}",
      false
  ],
  [
      "Inside (All)",
      "Finish Oven}:",
      false
  ]
 ]

The response is a JSON array. Each element in the array contains three items.

The first item is an English description of a choice (ie 'All Items', 'Items Inside', specific properties etc.).

The second is an updated selector that matches the name. If a user was to pick one of the options, this is what their selector should be changed into.

The third is either 'true' or 'false' to indicate if the choice is terminal or not. The user selecting a terminal option would normally finish the interactive session (ie. close the popup, execute the query etc.).