PostApplyLineKeyTemplateRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PostApplyLineKeyTemplateRequest",
  "title": "PostApplyLineKeyTemplateRequest",
  "type": "object",
  "required": [
    "action",
    "templateId"
  ],
  "properties": {
    "action": {
      "type": "string",
      "enum": [
        "APPLY_TEMPLATE",
        "APPLY_DEFAULT_TEMPLATES"
      ],
      "description": "Line key Template action to perform.\n * `APPLY_TEMPLATE` - Used to apply LinekeyTemplate to devices.\n * `APPLY_DEFAULT_TEMPLATES` - Used to reset devices to its default Linekey Template configurations.\n"
    },
    "templateId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL1VTL0RFVklDRV9MSU5FX0tFWV9URU1QTEFURS9kNDUzM2MwYi1hZGRmLTRjODUtODk0YS1hZTVkOTAyYzAyMDM=",
      "description": "`templateId` is required for `APPLY_TEMPLATE` action."
    },
    "locationIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Used to search for devices only in the given locations."
    },
    "excludeDevicesWithCustomLayout": {
      "type": "boolean",
      "description": "Indicates whether to exclude devices with custom layout."
    },
    "includeDeviceTags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Include devices only with these tags."
    },
    "excludeDeviceTags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Exclude devices with these tags."
    },
    "advisoryTypes": {
      "$ref": "#/components/schemas/LineKeyTemplateAdvisoryTypes",
      "description": "Refine search with advisories."
    }
  }
}