List Instance Templates¶

interface ListInstanceTemplatesResponse {
  templates: InstanceTemplate[];
}

interface InstanceTemplate {

  // Template name.
  name: string;

  // Human-friendly description
  description: string;

  // List of variables that this template may expect
  variables: TemplateVariable[];
}

interface TemplateVariable {

  // Variable name.
  name: string;

  // Verbose name for use in UI forms
  label: string;

  // Type of variable (Java class extending org.yamcs.templating.Variable)
  type: string;

  // Verbose user guidance (HTML)
  help: string;

  // Whether this variable is required input
  required: boolean;

  // List of valid choices
  choices: string[];

  // Initial value for use in UI forms
  initial: string;
}