{
  "swagger" : "2.0",
  "info" : {
    "description" : "Specification for retrieving and modifying Alarms",
    "version" : "1.0",
    "title" : "Alarms"
  },
  "tags" : [ {
    "name" : "Alarms service information"
  }, {
    "name" : "Retrieve and modify alarms (version 1)"
  }, {
    "name" : "Retrieve and modify alarms (version 2)"
  }, {
    "name" : "Search and filter alarms (version 1)"
  }, {
    "name" : "Search and filter alarms (version 2)"
  } ],
  "paths" : {
    "/nsa/api/v1/alarms/alarmRecordsCounts" : {
      "get" : {
        "tags" : [ "Retrieve and modify alarms (version 1)" ],
        "summary" : "Get the total number of Alarm records in the system.",
        "description" : "Alarm record counts returned in JSON format.",
        "operationId" : "getTotalRecordsCount",
        "produces" : [ "application/json" ],
        "responses" : {
          "200" : {
            "description" : "Successfully retrieved the total number of alarm records",
            "schema" : {
              "$ref" : "#/definitions/TotalAlarmRecordsCount"
            }
          },
          "500" : {
            "description" : "Request failed (error message provided)",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          }
        }
      }
    },
    "/nsa/api/v1/alarms/device-types" : {
      "get" : {
        "tags" : [ "Retrieve and modify alarms (version 1)" ],
        "summary" : "Get a collection of Alarmed device types.",
        "description" : "Device types returned in JSON format.",
        "operationId" : "getDeviceTypes",
        "produces" : [ "application/json" ],
        "responses" : {
          "200" : {
            "description" : "Successfully retrieved device types",
            "schema" : {
              "$ref" : "#/definitions/DeviceTypesRO"
            }
          },
          "400" : {
            "description" : "Bad Request",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "404" : {
            "description" : "No device types found",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "500" : {
            "description" : "Returning collection of device types failed",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          }
        }
      }
    },
    "/nsa/api/v1/alarms/deviceAttributes/{Id}" : {
      "get" : {
        "tags" : [ "Retrieve and modify alarms (version 1)" ],
        "summary" : "Get the device specific attributes for a device session id.",
        "description" : "Device specific attributes returned in JSON format.",
        "operationId" : "getDeviceAttributes",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "Id",
          "in" : "path",
          "description" : "Requested node Identifier.",
          "required" : true,
          "type" : "string"
        } ],
        "responses" : {
          "200" : {
            "description" : "Successfully retrieved device attributes by device session id",
            "schema" : {
              "$ref" : "#/definitions/DeviceAttributesRO"
            }
          },
          "400" : {
            "description" : "Bad Request",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "404" : {
            "description" : "Device attributes not found",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "500" : {
            "description" : "Device attributes request failed (error message provided)",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          }
        }
      }
    },
    "/nsa/api/v1/alarms/filter/activeAlarms" : {
      "get" : {
        "tags" : [ "Search and filter alarms (version 1)" ],
        "summary" : "Search/Filter active Alarms on the system.",
        "description" : "List of active Alarms returned in JSON format.",
        "operationId" : "searchActiveAlarms",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "severity",
          "in" : "query",
          "description" : "Severity values as a comma separated list. Example: CRITICAL, MAJOR, MINOR, WARNING",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "serviceAffecting",
          "in" : "query",
          "description" : "Service Affecting values as a comma separated list. Example: SERVICE_AFFECTING, NON_SERVICE_AFFECTING",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "deviceType",
          "in" : "query",
          "description" : "Device type values as a comma separated list. Example: OPENSTACK, CN6500, NUAGE",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "acknowledgeState",
          "in" : "query",
          "description" : "Acknowledgment state values as a comma separated list.Example: ACKNOWLEDGED, NOT_ACKNOWLEDGED",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "keytext",
          "in" : "query",
          "description" : "Key text to be present in the supported alarm fields. Supported fields include: condition-severity, node-name, resource, acknowledge-state, native-condition-type, and additional-text. Several operators are available including '+' (AND), '|' (OR), '-' (negate).",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "range",
          "in" : "query",
          "description" : "Comma separated last raised time range in format: yyyy-MM-ddTHH:mm:ss.SSS. Example: 1900-01-01T00:00:00.000,2999-12-31T23:59:59.999",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "sorting",
          "in" : "query",
          "description" : "Alarm attribute that the response will be sorted on, such as raiseTime, either in ascending or descending order. Example: last-raise-time:DESC",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "offset",
          "in" : "query",
          "description" : "Offset for the next page of results. Example: 50",
          "required" : false,
          "type" : "string",
          "default" : "0"
        }, {
          "name" : "pageSize",
          "in" : "query",
          "description" : "Limit of the number of alarms present in a page.",
          "required" : false,
          "type" : "string",
          "default" : "500"
        } ],
        "responses" : {
          "200" : {
            "description" : "Successfully retrieved filtered list of alarms",
            "schema" : {
              "$ref" : "#/definitions/ActiveAlarms"
            }
          },
          "400" : {
            "description" : "Bad request",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "500" : {
            "description" : "Search on alarms failed (error message provided)",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          }
        },
        "deprecated" : true
      }
    },
    "/nsa/api/v1/alarms/filter/historicalAlarms" : {
      "get" : {
        "tags" : [ "Search and filter alarms (version 1)" ],
        "summary" : "Search/Filter historical cleared Alarms on the system.",
        "description" : "List of historical cleared Alarms returned in JSON format.",
        "operationId" : "searchHistoricalAlarms",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "severity",
          "in" : "query",
          "description" : "Severity values as a comma separated list. Example: CRITICAL, MAJOR, MINOR, WARNING",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "serviceAffecting",
          "in" : "query",
          "description" : "Service Affecting values as a comma separated list. Example: SERVICE_AFFECTING, NON_SERVICE_AFFECTING",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "deviceType",
          "in" : "query",
          "description" : "Device type values as a comma separated list. Example: OPENSTACK, CN6500, NUAGE",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "keytext",
          "in" : "query",
          "description" : "Key text to be present in the supported alarm fields. Supported fields include: condition-severity, node-name, resource, acknowledge-state, native-condition-type, and additional-text. Several operators are available including '+' (AND), '|' (OR), '-' (negate).",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "range",
          "in" : "query",
          "description" : "Comma separated clear time range in format: yyyy-MM-ddTHH:mm:ss.SSS. Example: 1900-01-01T0:0:0.000,2999-12-31T23:59:59.999",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "sorting",
          "in" : "query",
          "description" : "Alarm attribute that the response will be sorted on, such as raiseTime, either in ascending or descending order. Example: last-raise-time:DESC",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "offset",
          "in" : "query",
          "description" : "Offset for the next page of results. Example: 50",
          "required" : false,
          "type" : "string",
          "default" : "0"
        }, {
          "name" : "pageSize",
          "in" : "query",
          "description" : "Limit of the number of alarms present in a page.",
          "required" : false,
          "type" : "string",
          "default" : "500"
        } ],
        "responses" : {
          "200" : {
            "description" : "Successfully retrieved filtered list of alarms",
            "schema" : {
              "$ref" : "#/definitions/HistoricalAlarms"
            }
          },
          "400" : {
            "description" : "Bad request",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "500" : {
            "description" : "Search on alarms failed (error message provided)",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          }
        },
        "deprecated" : true
      }
    },
    "/nsa/api/v1/alarms/historicalAlarms/{retentionDate}" : {
      "delete" : {
        "tags" : [ "Retrieve and modify alarms (version 1)" ],
        "summary" : "Remove historical alarms of the day specified in yyyymmdd format.",
        "description" : "Use with caution!",
        "operationId" : "removeOldHistoricalAlarms",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "retentionDate",
          "in" : "path",
          "description" : "Removed date in _yyyymmdd_ format",
          "required" : true,
          "type" : "string"
        } ],
        "responses" : {
          "204" : {
            "description" : "Successfully removed historical alarms"
          },
          "400" : {
            "description" : "Bad Request",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "500" : {
            "description" : "Removing historical alarms failed (error message provided)",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          }
        }
      }
    },
    "/nsa/api/v1/alarms/historicalChangePartition" : {
      "get" : {
        "tags" : [ "Retrieve and modify alarms (version 1)" ],
        "summary" : "Get configuration of if historical alarms change partition.",
        "description" : "",
        "operationId" : "getHistoricalChangePartition",
        "produces" : [ "application/json" ],
        "responses" : {
          "200" : {
            "description" : "Successfully return the configured historical change partition",
            "schema" : {
              "$ref" : "#/definitions/RetentionDaysRO"
            }
          },
          "400" : {
            "description" : "Bad Request",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "500" : {
            "description" : "Failed to get the historical change partition (error message provided)",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          }
        },
        "deprecated" : true
      }
    },
    "/nsa/api/v1/alarms/historicalDataRetentionDays" : {
      "get" : {
        "tags" : [ "Retrieve and modify alarms (version 1)" ],
        "summary" : "Get configuration of historical data retention days.",
        "description" : "",
        "operationId" : "getHistoricalDataRetentionDays",
        "produces" : [ "application/json" ],
        "responses" : {
          "200" : {
            "description" : "Successfully return the configured historical data retention days",
            "schema" : {
              "$ref" : "#/definitions/RetentionDaysRO"
            }
          },
          "400" : {
            "description" : "Bad Request",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "500" : {
            "description" : "Failed to get the historical data retention days (error message provided)",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          }
        },
        "deprecated" : true
      }
    },
    "/nsa/api/v1/alarms/historicalDataRetentionDays/{retentionDays}" : {
      "put" : {
        "tags" : [ "Retrieve and modify alarms (version 1)" ],
        "summary" : "Set configuration of historical data retention days.",
        "description" : "Use with caution! The expired data based on the new retention day will be deleted.",
        "operationId" : "setHistoricalDataRetentionDays",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "retentionDays",
          "in" : "path",
          "description" : "Number of historical data retention days. Must be between 1 - 365",
          "required" : true,
          "type" : "integer",
          "format" : "int32"
        } ],
        "responses" : {
          "200" : {
            "description" : "Successfully set the new historical data retention days"
          },
          "400" : {
            "description" : "Bad Request",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "500" : {
            "description" : "Set the new historical data retention days failed (error message provided)",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          }
        },
        "deprecated" : true
      }
    },
    "/nsa/api/v1/alarms/{Id}/acknowledge" : {
      "post" : {
        "tags" : [ "Retrieve and modify alarms (version 1)" ],
        "summary" : "Acknowledge an active Alarm based on its identifier.",
        "description" : "Only active Alarms can be acknowledged.",
        "operationId" : "acknowledgeAlarmV1",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "Id",
          "in" : "path",
          "description" : "Identifier of the alarm to be marked as _acknowledged_.",
          "required" : true,
          "type" : "string"
        } ],
        "responses" : {
          "204" : {
            "description" : "Successfully acknowledged alarm"
          },
          "400" : {
            "description" : "Bad Request",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "404" : {
            "description" : "Alarm not found",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "500" : {
            "description" : "Acknowledging a specific active alarm failed (error message provided)",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          }
        },
        "deprecated" : true
      }
    },
    "/nsa/api/v1/alarms/{Id}/force-clear" : {
      "post" : {
        "tags" : [ "Retrieve and modify alarms (version 1)" ],
        "summary" : "Force clear an active Alarm based on its identifier (irrespective of its clearable flag).",
        "description" : "Never use this REST API unless you have no other option.",
        "operationId" : "forceClearAlarmV1",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "Id",
          "in" : "path",
          "description" : "Identifier of the alarm to be marked as _cleared_.",
          "required" : true,
          "type" : "string"
        } ],
        "responses" : {
          "204" : {
            "description" : "Successfully force cleared alarm"
          },
          "400" : {
            "description" : "Bad Request",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "404" : {
            "description" : "Alarm not found",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "500" : {
            "description" : "Clearing a specific active alarm failed (error message provided)",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          }
        },
        "deprecated" : true
      }
    },
    "/nsa/api/v1/alarms/{Id}/manual-clear" : {
      "post" : {
        "tags" : [ "Retrieve and modify alarms (version 1)" ],
        "summary" : "Manually clear an active Alarm based on its identifier.",
        "description" : "Only manually clearable alarms can be cleared.",
        "operationId" : "manualClearAlarmV1",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "Id",
          "in" : "path",
          "description" : "Identifier of the alarm to be marked as _cleared_.",
          "required" : true,
          "type" : "string"
        } ],
        "responses" : {
          "204" : {
            "description" : "Successfully manually cleared alarm"
          },
          "400" : {
            "description" : "Bad Request",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "404" : {
            "description" : "Alarm not found",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "500" : {
            "description" : "Clearing a specific active alarm failed (error message provided)",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          }
        },
        "deprecated" : true
      }
    },
    "/nsa/api/v1/alarms/{Id}/unacknowledge" : {
      "post" : {
        "tags" : [ "Retrieve and modify alarms (version 1)" ],
        "summary" : "Unacknowledge an active Alarm based on its identifier.",
        "description" : "Only active Alarms can be unacknowledged.",
        "operationId" : "unacknowledgeAlarmV1",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "Id",
          "in" : "path",
          "description" : "Identifier of the alarm to be marked as _unacknowledged_.",
          "required" : true,
          "type" : "string"
        } ],
        "responses" : {
          "204" : {
            "description" : "Successfully un-acknowledged alarm"
          },
          "400" : {
            "description" : "Bad Request",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "404" : {
            "description" : "Alarm not found",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "500" : {
            "description" : "Un-acknowledging a specific active alarm failed (error message provided)",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          }
        },
        "deprecated" : true
      }
    },
    "/nsa/api/v1/info" : {
      "get" : {
        "tags" : [ "Alarms service information" ],
        "summary" : "Gets the alarm service status info.",
        "description" : "",
        "operationId" : "getInfo",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "threadDump",
          "in" : "query",
          "description" : "Generate an alarm processor thread dump.",
          "required" : false,
          "type" : "boolean"
        } ],
        "responses" : {
          "default" : {
            "description" : "successful operation"
          }
        }
      }
    },
    "/nsa/api/v1/ping" : {
      "get" : {
        "tags" : [ "Alarms service information" ],
        "summary" : "Used to check if the alarms processor service is alive.",
        "description" : "",
        "operationId" : "ping",
        "produces" : [ "text/plain" ],
        "responses" : {
          "200" : {
            "description" : "successful operation",
            "schema" : {
              "type" : "string"
            }
          }
        }
      }
    },
    "/nsa/api/v2_0/alarms/alarm-sync-states" : {
      "post" : {
        "tags" : [ "Retrieve and modify alarms (version 2)" ],
        "summary" : "Get a collection of alarm sync states of given nodes",
        "description" : "",
        "operationId" : "getAlarmSyncStates",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "in" : "body",
          "name" : "body",
          "description" : "Alarm query list",
          "required" : true,
          "schema" : {
            "$ref" : "#/definitions/AlarmQueryList"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "Successfully retrieved alarm sync states",
            "schema" : {
              "$ref" : "#/definitions/NodeAlarmStateRO"
            }
          },
          "500" : {
            "description" : "Internal error",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          }
        }
      }
    },
    "/nsa/api/v2_0/alarms/filter" : {
      "get" : {
        "tags" : [ "Search and filter alarms (version 2)" ],
        "summary" : "Get all alarm filters active on the system.",
        "description" : "",
        "operationId" : "getAllFilters",
        "produces" : [ "application/json" ],
        "responses" : {
          "200" : {
            "description" : "Successfully retrieved alarm filters",
            "schema" : {
              "$ref" : "#/definitions/Filters"
            }
          },
          "500" : {
            "description" : "Filter creation failed",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          }
        }
      },
      "post" : {
        "tags" : [ "Search and filter alarms (version 2)" ],
        "summary" : "Create a unique Alarm filter.",
        "description" : "",
        "operationId" : "createFilter",
        "consumes" : [ "application/json" ],
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "in" : "body",
          "name" : "body",
          "description" : "Alarm filter",
          "required" : true,
          "schema" : {
            "$ref" : "#/definitions/Filter"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "successful operation",
            "schema" : {
              "$ref" : "#/definitions/Filter"
            }
          },
          "201" : {
            "description" : "Filter successfully created",
            "schema" : {
              "$ref" : "#/definitions/Filter"
            }
          },
          "400" : {
            "description" : "Bad Request",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "403" : {
            "description" : "Forbidden",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "500" : {
            "description" : "Filter creation failed",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          }
        }
      }
    },
    "/nsa/api/v2_0/alarms/filter/activeAlarmCounts" : {
      "get" : {
        "tags" : [ "Search and filter alarms (version 2)" ],
        "summary" : "Query active alarm counts of severity CRITICAL, MAJOR, MINOR and WARNING.",
        "description" : "",
        "operationId" : "getActiveAlarmCounts",
        "produces" : [ "application/json" ],
        "responses" : {
          "200" : {
            "description" : "Successfully retrieved alarm counts",
            "schema" : {
              "$ref" : "#/definitions/FilteredAlarms"
            }
          },
          "400" : {
            "description" : "Bad Request",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "500" : {
            "description" : "Alarm counts retrieval failed (error message provided)",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          }
        }
      }
    },
    "/nsa/api/v2_0/alarms/filter/activeAlarms" : {
      "get" : {
        "tags" : [ "Search and filter alarms (version 2)" ],
        "summary" : "Search/Filter active Alarms on the system.",
        "description" : "List of active Alarms returned in JSON format.",
        "operationId" : "searchActiveAlarmsV2",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "filter[severity]",
          "in" : "query",
          "description" : "Severity values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>**Example**: _CRITICAL, MAJOR, MINOR, WARNING_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[serviceAffecting]",
          "in" : "query",
          "description" : "Service affecting values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>**Example**: _SERVICE_AFFECTING, NON_SERVICE_AFFECTING_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[deviceType]",
          "in" : "query",
          "description" : "Device type values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>**Example**: _6500, OPENSTACK, NUAGE_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[acknowledgeState]",
          "in" : "query",
          "description" : "Acknowledgment state values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>**Example**: _ACKNOWLEDGED, NOT_ACKNOWLEDGED_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[deviceId]",
          "in" : "query",
          "description" : "Device id values as a comma separated list.<p>**Example**: _ID1, ID2_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[deviceName]",
          "in" : "query",
          "description" : "Case sensitive device name values as a comma separated list.<p>**Example**: _NAME1, NAME2_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[ipAddress]",
          "in" : "query",
          "description" : "IP address values as a comma separated list.<p>**Example**: _192.168.42.2, 192.168.42.3_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[macAddress]",
          "in" : "query",
          "description" : "Case sensitive MAC address values as a comma separated list.<p>**Example**: _00-04-DC-01-02-03, 00-04-DC-01-02-04_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[additionalText]",
          "in" : "query",
          "description" : "Additional text values as a comma separated list.<p>**Example**: _TEXT1, TEXT2_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[nativeConditionType]",
          "in" : "query",
          "description" : "Native condition type values as a comma separated list.<p>**Example**: _TYPE1, TYPE2_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[resource]",
          "in" : "query",
          "description" : "Resource values as a comma separated list.<p>**Example**: _RESOURCE1, RESOURCE2_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[subnetName]",
          "in" : "query",
          "description" : "Case sensitive subnet name values as a comma separated list.<p>**Example**: _SUBNET01, SUBNET02_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[cardType]",
          "in" : "query",
          "description" : "Card type values as a comma separated list.<p>**Example**: _SP-2_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[clfi]",
          "in" : "query",
          "description" : "CLFI values as a comma separated list.<p>**Example**: _CLFI01, CLFI02_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[fic]",
          "in" : "query",
          "description" : "FIC values as a comma separated list.<p>**Example**: _FIC01, FIC02_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[keytext]",
          "in" : "query",
          "description" : "Key text, minimum 3 characters, to be present in the supported alarm fields.<p>Supported fields include: _condition-severity, device-name, device-long-name, resource, acknowledge-state, native-condition-type, additional-text_, and _service-affecting_.</p><p>Several operators are available including '+' (AND), '|' (OR), '-' (negate).</p><p>Spaces are considered to be OR by default.</p><p>Results without this key text will not be shown in the results context aggregations meta.</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[lastRaisedTime]",
          "in" : "query",
          "description" : "Comma separated last raised time range in the format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T00:00:00.000, 2999-12-31T23:59:59.999_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "sorting",
          "in" : "query",
          "description" : "Alarm attribute that the response will be sorted on such as _raiseTime_, either in ascending (ASC) or descending (DESC) order.<p>Values can be provided as a comma separated list or in new lines.</p><p>The latter translates to _sort[]=value1&sort[]=value2&_ ...</p><p>**Example**: _last-raise-time:DESC_</p><p>The JSON API standard is also accepted: _-last-raise-time_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "offset",
          "in" : "query",
          "description" : "Offset for the next page of results.<p>**Example**: _50_</p>",
          "required" : false,
          "type" : "string",
          "default" : "0"
        }, {
          "name" : "pageSize",
          "in" : "query",
          "description" : "Limit of the number of alarms present in a page.",
          "required" : false,
          "type" : "string",
          "default" : "500"
        } ],
        "responses" : {
          "200" : {
            "description" : "Successfully retrieved filtered list of alarms",
            "schema" : {
              "$ref" : "#/definitions/FilteredAlarms"
            }
          },
          "400" : {
            "description" : "Bad request",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "500" : {
            "description" : "Search on alarms failed (error message provided)",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          }
        },
        "deprecated" : true
      }
    },
    "/nsa/api/v2_0/alarms/filter/additionalTextAggregations" : {
      "get" : {
        "tags" : [ "Search and filter alarms (version 2)" ],
        "summary" : "Query for additional texts in context. Returns a subset of the total additional texts in the system.",
        "description" : "Returned in JSON format.",
        "operationId" : "getAdditionalTexts",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "filter[additionalText]",
          "in" : "query",
          "description" : "Partial additional text filter value with a minimum of 3 characters.<p>**Example**: _TEX_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "selected[additionalText][]",
          "in" : "query",
          "description" : "Additional text values as a comma separated list.<p>**Example**: _TEXT1, TEXT2_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[contextState][]",
          "in" : "query",
          "description" : "State values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _ACTIVE, CLEARED, SUPERSEDED_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[keytext]",
          "in" : "query",
          "description" : "Key text, minimum 3 characters, to be present in the supported alarm fields.<p>Supported fields include: _condition-severity, device-name, device-long-name, resource, acknowledge-state, native-condition-type, additional-text_, and _service-affecting_.</p><p>Several operators are available including '+' (AND), '|' (OR), '-' (negate).</p><p>Spaces are considered to be OR by default.</p><p>Results without this key text will not be shown in the results context aggregations meta.</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[lastRaisedTime]",
          "in" : "query",
          "description" : "Comma separated last raised time range in the format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T00:00:00.000, 2999-12-31T23:59:59.999_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[clearTime]",
          "in" : "query",
          "description" : "Comma separated clear time range in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T0:0:0.000, 2999-12-31T23:59:59.999_</p>",
          "required" : false,
          "type" : "string"
        } ],
        "responses" : {
          "200" : {
            "description" : "Successfully retrieved additional texts",
            "schema" : {
              "$ref" : "#/definitions/AdditionalTextsAggregation"
            }
          },
          "400" : {
            "description" : "Bad Request",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "500" : {
            "description" : "Additional texts retrieval failed (error message provided)",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          }
        }
      }
    },
    "/nsa/api/v2_0/alarms/filter/deviceNamesAggregations" : {
      "get" : {
        "tags" : [ "Search and filter alarms (version 2)" ],
        "summary" : "Query for device names in context. Returns a subset of the total device names in the system.",
        "description" : "Returned in JSON format.",
        "operationId" : "getDeviceNames",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "filter[deviceName]",
          "in" : "query",
          "description" : "Partial case sensitive device name filter value with a minimum of 3 characters.<p>**Example**: _NAME1_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "selected[deviceName][]",
          "in" : "query",
          "description" : "Case sensitive device name values as a comma separated list.<p>**Example**: _NAME1, NAME2_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[contextState][]",
          "in" : "query",
          "description" : "State values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _ACTIVE, CLEARED, SUPERSEDED_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[keytext]",
          "in" : "query",
          "description" : "Key text, minimum 3 characters, to be present in the supported alarm fields.<p>Supported fields include: _condition-severity, device-name, device-long-name, resource, acknowledge-state, native-condition-type, additional-text_, and _service-affecting_.</p><p>Several operators are available including '+' (AND), '|' (OR), '-' (negate).</p><p>Spaces are considered to be OR by default.</p><p>Results without this key text will not be shown in the results context aggregations meta.</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[lastRaisedTime]",
          "in" : "query",
          "description" : "Comma separated last raised time range in the format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T00:00:00.000, 2999-12-31T23:59:59.999_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[clearTime]",
          "in" : "query",
          "description" : "Comma separated clear time range in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T0:0:0.000, 2999-12-31T23:59:59.999_</p>",
          "required" : false,
          "type" : "string"
        } ],
        "responses" : {
          "200" : {
            "description" : "Successfully retrieved device names",
            "schema" : {
              "$ref" : "#/definitions/DeviceNamesAggregation"
            }
          },
          "400" : {
            "description" : "Bad Request",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "500" : {
            "description" : "Device names retrieval failed (error message provided)",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          }
        }
      }
    },
    "/nsa/api/v2_0/alarms/filter/endScrollFilteredAlarms" : {
      "post" : {
        "tags" : [ "Search and filter alarms (version 2)" ],
        "summary" : "End a scroll",
        "description" : "Make sure to end the scroll when it is not needed",
        "operationId" : "endScroll",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "scrollId",
          "in" : "query",
          "description" : "Scroll id returned from startScrollFilteredAlarm call.DnF1ZXJ5VGhlbkZldGNoAwAAAAAAADG0FmNTcGcweHJtUWVPeE5CN3ZNYm5CQVEAAAAAAAAxtRZjU3BnMHhybVFlT3hOQjd2TWJuQkFRAAAAAAAAMbYWY1NwZzB4cm1RZU94TkI3dk1ibkJBUQ==",
          "required" : true,
          "type" : "string"
        } ],
        "responses" : {
          "204" : {
            "description" : "Successfully end scroll"
          },
          "404" : {
            "description" : "Scroll not found",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "500" : {
            "description" : "Scroll end failed",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          }
        }
      }
    },
    "/nsa/api/v2_0/alarms/filter/filteredAlarms" : {
      "get" : {
        "tags" : [ "Search and filter alarms (version 2)" ],
        "summary" : "Search/Filter all Alarms on the system.",
        "description" : "List of filtered Alarms returned in JSON format.",
        "operationId" : "searchFilteredAlarms",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "filter[alarmId][]",
          "in" : "query",
          "description" : "Alarm id values as a comma separated list.<p>**Example**: _ID1, ID2_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[state][]",
          "in" : "query",
          "description" : "State values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _ACTIVE, CLEARED, SUPERSEDED_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[contextState][]",
          "in" : "query",
          "description" : "State values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _ACTIVE, CLEARED, SUPERSEDED_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[severity][]",
          "in" : "query",
          "description" : "Severity values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>**Example**: _CRITICAL, MAJOR, MINOR, WARNING_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[serviceAffecting][]",
          "in" : "query",
          "description" : "Service affecting values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>**Example**: _SERVICE_AFFECTING, NON_SERVICE_AFFECTING_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[deviceType][]",
          "in" : "query",
          "description" : "Device type values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>**Example**: _6500, OPENSTACK, NUAGE_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[acknowledgeState][]",
          "in" : "query",
          "description" : "Acknowledgment state values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>**Example**: _ACKNOWLEDGED, NOT_ACKNOWLEDGED_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[deviceId][]",
          "in" : "query",
          "description" : "Device id values as a comma separated list.<p>**Example**: _ID1, ID2_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[deviceName][]",
          "in" : "query",
          "description" : "Case sensitive device name values as a comma separated list.<p>**Example**: _NAME1, NAME2_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[ipAddress][]",
          "in" : "query",
          "description" : "IP address values as a comma separated list.<p>**Example**: _192.168.42.2, 192.168.42.3_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[macAddress][]",
          "in" : "query",
          "description" : "Case sensitive MAC address values as a comma separated list.<p>**Example**: _00-04-DC-01-02-03, 00-04-DC-01-02-04_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[additionalText][]",
          "in" : "query",
          "description" : "Additional text values as a comma separated list.<p>**Example**: _TEXT1, TEXT2_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[nativeConditionType][]",
          "in" : "query",
          "description" : "Native condition type values as a comma separated list.<p>**Example**: _TYPE1, TYPE2_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[resource][]",
          "in" : "query",
          "description" : "Resource values as a comma separated list.<p>**Example**: _RESOURCE1, RESOURCE2_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[resourceId][]",
          "in" : "query",
          "description" : "Resource ID values as a comma separated list.<p>**Example**: _RESOURCEID1, RESOURCEID2_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[subnetName][]",
          "in" : "query",
          "description" : "Case sensitive subnet name values as a comma separated list.<p>**Example**: _SUBNET01, SUBNET02_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[cardType][]",
          "in" : "query",
          "description" : "Card type values as a comma separated list.<p>**Example**: _SP-2_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[clfi][]",
          "in" : "query",
          "description" : "CLFI values as a comma separated list.<p>**Example**: _CLFI01, CLFI02_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[fic][]",
          "in" : "query",
          "description" : "FIC values as a comma separated list.<p>**Example**: _FIC01, FIC02_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[keytext]",
          "in" : "query",
          "description" : "Key text, minimum 3 characters, to be present in the supported alarm fields.<p>Supported fields include: _condition-severity, device-name, device-long-name, resource, acknowledge-state, native-condition-type, additional-text_, and _service-affecting_.</p><p>Several operators are available including '+' (AND), '|' (OR), '-' (negate).</p><p>Spaces are considered to be OR by default.</p><p>Results without this key text will not be shown in the results context aggregations meta.</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[lastRaisedTime]",
          "in" : "query",
          "description" : "Comma separated last raised time range in the format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T00:00:00.000, 2999-12-31T23:59:59.999_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[lastRaisedTimeFrom]",
          "in" : "query",
          "description" : "Last raised time to be searched after in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T00:00:00.000_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[lastRaisedTimeTo]",
          "in" : "query",
          "description" : "Last raised time to be searched before in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _2999-12-31T23:59:59.999_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[clearTime]",
          "in" : "query",
          "description" : "Comma separated clear time range in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T0:0:0.000, 2999-12-31T23:59:59.999_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[clearTimeFrom]",
          "in" : "query",
          "description" : "Last clear time to be searched after in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T00:00:00.000_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[clearTimeTo]",
          "in" : "query",
          "description" : "Last clear time to be searched before in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _2999-12-31T23:59:59.999_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "sort[]",
          "in" : "query",
          "description" : "Alarm attribute that the response will be sorted on such as _raiseTime_, either in ascending (ASC) or descending (DESC) order.<p>Values can be provided as a comma separated list or in new lines.</p><p>The latter translates to _sort[]=value1&sort[]=value2&_ ...</p><p>**Example**: _last-raise-time:DESC_</p><p>The JSON API standard is also accepted: _-last-raise-time_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[refinedRaisedTimeFrom]",
          "in" : "query",
          "description" : "Refined raised time to be searched after in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>**Example**: _1900-01-01T00:00:00.000_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[refinedRaisedTimeTo]",
          "in" : "query",
          "description" : "Refined raised time to be searched before in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>**Example**: _2999-12-31T23:59:59.999_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[refinedClearTimeFrom]",
          "in" : "query",
          "description" : "Refined cleared time to be searched after in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>**Example**: _1900-01-01T00:00:00.000_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[refinedClearTimeTo]",
          "in" : "query",
          "description" : "Refined clear time to be searched before in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>**Example**: _2999-12-31T23:59:59.999_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "offset",
          "in" : "query",
          "description" : "Offset for the next page of results.<p>**Example**: _50_</p>",
          "required" : false,
          "type" : "string",
          "default" : "0"
        }, {
          "name" : "pageSize",
          "in" : "query",
          "description" : "Limit of the number of alarms present in a page.",
          "required" : false,
          "type" : "string",
          "default" : "500"
        } ],
        "responses" : {
          "200" : {
            "description" : "Successfully retrieved filtered list of alarms",
            "schema" : {
              "$ref" : "#/definitions/FilteredAlarms"
            }
          },
          "400" : {
            "description" : "Bad request",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "500" : {
            "description" : "Search on alarms failed (error message provided)",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          }
        }
      }
    },
    "/nsa/api/v2_0/alarms/filter/filteredAlarms/{Id}" : {
      "get" : {
        "tags" : [ "Search and filter alarms (version 2)" ],
        "summary" : "Get an Alarm based on its identifier.",
        "description" : "Alarm returned in JSON format.",
        "operationId" : "getFilteredAlarm",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "Id",
          "in" : "path",
          "description" : "Requested alarm identifier.",
          "required" : true,
          "type" : "string"
        } ],
        "responses" : {
          "200" : {
            "description" : "Successfully retrieved alarm by ID",
            "schema" : {
              "$ref" : "#/definitions/FilteredAlarm"
            }
          },
          "400" : {
            "description" : "Bad Request",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "403" : {
            "description" : "Forbidden",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "404" : {
            "description" : "Alarm not found",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "500" : {
            "description" : "A specific active alarm retrieval failed (error message provided)",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          }
        }
      }
    },
    "/nsa/api/v2_0/alarms/filter/getCorrelatedAlarmsByService" : {
      "get" : {
        "tags" : [ "Search and filter alarms (version 2)" ],
        "summary" : "Search/Filter all correlated alarms on the system.",
        "description" : "List of filtered correlated alarms returned in JSON format.",
        "operationId" : "searchCorrelatedAlarms",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "serviceId",
          "in" : "query",
          "description" : "service Id",
          "required" : true,
          "type" : "string"
        }, {
          "name" : "filter[severity][]",
          "in" : "query",
          "description" : "Severity values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>**Example**: _CRITICAL, MAJOR, MINOR, WARNING_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[serviceAffecting][]",
          "in" : "query",
          "description" : "Service affecting values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>**Example**: _SERVICE_AFFECTING, NON_SERVICE_AFFECTING_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[deviceType][]",
          "in" : "query",
          "description" : "Device type values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>**Example**: _6500, OPENSTACK, NUAGE_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[acknowledgeState][]",
          "in" : "query",
          "description" : "Acknowledgment state values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>**Example**: _ACKNOWLEDGED, NOT_ACKNOWLEDGED_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[deviceId][]",
          "in" : "query",
          "description" : "Device id values as a comma separated list.<p>**Example**: _ID1, ID2_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[deviceName][]",
          "in" : "query",
          "description" : "Case sensitive device name values as a comma separated list.<p>**Example**: _NAME1, NAME2_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[ipAddress][]",
          "in" : "query",
          "description" : "IP address values as a comma separated list.<p>**Example**: _192.168.42.2, 192.168.42.3_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[macAddress][]",
          "in" : "query",
          "description" : "Case sensitive MAC address values as a comma separated list.<p>**Example**: _00-04-DC-01-02-03, 00-04-DC-01-02-04_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[additionalText][]",
          "in" : "query",
          "description" : "Additional text values as a comma separated list.<p>**Example**: _TEXT1, TEXT2_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[nativeConditionType][]",
          "in" : "query",
          "description" : "Native condition type values as a comma separated list.<p>**Example**: _TYPE1, TYPE2_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[resource][]",
          "in" : "query",
          "description" : "Resource values as a comma separated list.<p>**Example**: _RESOURCE1, RESOURCE2_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[resourceId][]",
          "in" : "query",
          "description" : "Resource ID values as a comma separated list.<p>**Example**: _RESOURCEID1, RESOURCEID2_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[subnetName][]",
          "in" : "query",
          "description" : "Case sensitive subnet name values as a comma separated list.<p>**Example**: _SUBNET01, SUBNET02_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[cardType][]",
          "in" : "query",
          "description" : "Card type values as a comma separated list.<p>**Example**: _SP-2_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[clfi][]",
          "in" : "query",
          "description" : "CLFI values as a comma separated list.<p>**Example**: _CLFI01, CLFI02_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[fic][]",
          "in" : "query",
          "description" : "FIC values as a comma separated list.<p>**Example**: _FIC01, FIC02_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[keytext]",
          "in" : "query",
          "description" : "Key text, minimum 3 characters, to be present in the supported alarm fields.<p>Supported fields include: _condition-severity, device-name, device-long-name, resource, acknowledge-state, native-condition-type, additional-text_, and _service-affecting_.</p><p>Several operators are available including '+' (AND), '|' (OR), '-' (negate).</p><p>Spaces are considered to be OR by default.</p><p>Results without this key text will not be shown in the results context aggregations meta.</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[lastRaisedTime]",
          "in" : "query",
          "description" : "Comma separated last raised time range in the format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T00:00:00.000, 2999-12-31T23:59:59.999_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[lastRaisedTimeFrom]",
          "in" : "query",
          "description" : "Last raised time to be searched after in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T00:00:00.000_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[lastRaisedTimeTo]",
          "in" : "query",
          "description" : "Last raised time to be searched before in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _2999-12-31T23:59:59.999_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[clearTime]",
          "in" : "query",
          "description" : "Comma separated clear time range in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T0:0:0.000, 2999-12-31T23:59:59.999_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[clearTimeFrom]",
          "in" : "query",
          "description" : "Last clear time to be searched after in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T00:00:00.000_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[clearTimeTo]",
          "in" : "query",
          "description" : "Last clear time to be searched before in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _2999-12-31T23:59:59.999_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "sort[]",
          "in" : "query",
          "description" : "Alarm attribute that the response will be sorted on such as _raiseTime_, either in ascending (ASC) or descending (DESC) order.<p>Values can be provided as a comma separated list or in new lines.</p><p>The latter translates to _sort[]=value1&sort[]=value2&_ ...</p><p>**Example**: _last-raise-time:DESC_</p><p>The JSON API standard is also accepted: _-last-raise-time_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[refinedRaisedTimeFrom]",
          "in" : "query",
          "description" : "Refined raised time to be searched after in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>**Example**: _1900-01-01T00:00:00.000_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[refinedRaisedTimeTo]",
          "in" : "query",
          "description" : "Refined raised time to be searched before in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>**Example**: _2999-12-31T23:59:59.999_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[refinedClearTimeFrom]",
          "in" : "query",
          "description" : "Refined cleared time to be searched after in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>**Example**: _1900-01-01T00:00:00.000_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[refinedClearTimeTo]",
          "in" : "query",
          "description" : "Refined clear time to be searched before in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>**Example**: _2999-12-31T23:59:59.999_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "offset",
          "in" : "query",
          "description" : "Offset for the next page of results.<p>**Example**: _50_</p>",
          "required" : false,
          "type" : "string",
          "default" : "0"
        }, {
          "name" : "pageSize",
          "in" : "query",
          "description" : "Limit of the number of alarms present in a page.",
          "required" : false,
          "type" : "string",
          "default" : "500"
        } ],
        "responses" : {
          "200" : {
            "description" : "Successfully retrieved filtered list of correlated alarms",
            "schema" : {
              "$ref" : "#/definitions/FilteredAlarms"
            }
          },
          "400" : {
            "description" : "Bad request",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "500" : {
            "description" : "Search on alarms failed (error message provided)",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          }
        }
      }
    },
    "/nsa/api/v2_0/alarms/filter/historicalAlarms" : {
      "get" : {
        "tags" : [ "Search and filter alarms (version 2)" ],
        "summary" : "Search/Filter historical cleared Alarms on the system.",
        "description" : "List of historical cleared Alarms returned in JSON format.",
        "operationId" : "searchHistoricalAlarmsV2",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "filter[severity]",
          "in" : "query",
          "description" : "Severity values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>**Example**: _CRITICAL, MAJOR, MINOR, WARNING_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[serviceAffecting]",
          "in" : "query",
          "description" : "Service affecting values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>**Example**: _SERVICE_AFFECTING, NON_SERVICE_AFFECTING_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[deviceType]",
          "in" : "query",
          "description" : "Device type values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>**Example**: _6500, OPENSTACK, NUAGE_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[deviceId]",
          "in" : "query",
          "description" : "Device id values as a comma separated list.<p>**Example**: _ID1, ID2_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[deviceName]",
          "in" : "query",
          "description" : "Case sensitive device name values as a comma separated list.<p>**Example**: _NAME1, NAME2_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[ipAddress]",
          "in" : "query",
          "description" : "IP address values as a comma separated list.<p>**Example**: _192.168.42.2, 192.168.42.3_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[macAddress]",
          "in" : "query",
          "description" : "Case sensitive MAC address values as a comma separated list.<p>**Example**: _00-04-DC-01-02-03, 00-04-DC-01-02-04_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[additionalText]",
          "in" : "query",
          "description" : "Additional text values as a comma separated list.<p>**Example**: _TEXT1, TEXT2_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[nativeConditionType]",
          "in" : "query",
          "description" : "Native condition type values as a comma separated list.<p>**Example**: _TYPE1, TYPE2_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[resource]",
          "in" : "query",
          "description" : "Resource values as a comma separated list.<p>**Example**: _RESOURCE1, RESOURCE2_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[subnetName]",
          "in" : "query",
          "description" : "Case sensitive subnet name values as a comma separated list.<p>**Example**: _SUBNET01, SUBNET02_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[cardType]",
          "in" : "query",
          "description" : "Card type values as a comma separated list.<p>**Example**: _SP-2_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[clfi]",
          "in" : "query",
          "description" : "CLFI values as a comma separated list.<p>**Example**: _CLFI01, CLFI02_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[fic]",
          "in" : "query",
          "description" : "FIC values as a comma separated list.<p>**Example**: _FIC01, FIC02_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[keytext]",
          "in" : "query",
          "description" : "Key text, minimum 3 characters, to be present in the supported alarm fields.<p>Supported fields include: _condition-severity, device-name, device-long-name, resource, acknowledge-state, native-condition-type, additional-text_, and _service-affecting_.</p><p>Several operators are available including '+' (AND), '|' (OR), '-' (negate).</p><p>Spaces are considered to be OR by default.</p><p>Results without this key text will not be shown in the results context aggregations meta.</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[clearTime]",
          "in" : "query",
          "description" : "Comma separated clear time range in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T0:0:0.000, 2999-12-31T23:59:59.999_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "sorting",
          "in" : "query",
          "description" : "Alarm attribute that the response will be sorted on such as _raiseTime_, either in ascending (ASC) or descending (DESC) order.<p>Values can be provided as a comma separated list or in new lines.</p><p>The latter translates to _sort[]=value1&sort[]=value2&_ ...</p><p>**Example**: _last-raise-time:DESC_</p><p>The JSON API standard is also accepted: _-last-raise-time_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "offset",
          "in" : "query",
          "description" : "Offset for the next page of results.<p>**Example**: _50_</p>",
          "required" : false,
          "type" : "string",
          "default" : "0"
        }, {
          "name" : "pageSize",
          "in" : "query",
          "description" : "Limit of the number of alarms present in a page.",
          "required" : false,
          "type" : "string",
          "default" : "500"
        } ],
        "responses" : {
          "200" : {
            "description" : "Successfully retrieved filtered list of alarms",
            "schema" : {
              "$ref" : "#/definitions/FilteredAlarms"
            }
          },
          "400" : {
            "description" : "Bad request",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "500" : {
            "description" : "Search on alarms failed (error message provided)",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          }
        },
        "deprecated" : true
      }
    },
    "/nsa/api/v2_0/alarms/filter/ipAddressesAggregations" : {
      "get" : {
        "tags" : [ "Search and filter alarms (version 2)" ],
        "summary" : "Query for IP addresses in context. Returns a subset of the total IP addresses in the system.",
        "description" : "Returned in JSON format.",
        "operationId" : "getIpAddresses",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "filter[ipAddress]",
          "in" : "query",
          "description" : "Partial IP address filter value with a minimum of 3 characters.<p>**Example**: _192.168_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "selected[ipAddress][]",
          "in" : "query",
          "description" : "IP address values as a comma separated list.<p>**Example**: _192.168.42.2, 192.168.42.3_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[contextState][]",
          "in" : "query",
          "description" : "State values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _ACTIVE, CLEARED, SUPERSEDED_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[keytext]",
          "in" : "query",
          "description" : "Key text, minimum 3 characters, to be present in the supported alarm fields.<p>Supported fields include: _condition-severity, device-name, device-long-name, resource, acknowledge-state, native-condition-type, additional-text_, and _service-affecting_.</p><p>Several operators are available including '+' (AND), '|' (OR), '-' (negate).</p><p>Spaces are considered to be OR by default.</p><p>Results without this key text will not be shown in the results context aggregations meta.</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[lastRaisedTime]",
          "in" : "query",
          "description" : "Comma separated last raised time range in the format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T00:00:00.000, 2999-12-31T23:59:59.999_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[clearTime]",
          "in" : "query",
          "description" : "Comma separated clear time range in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T0:0:0.000, 2999-12-31T23:59:59.999_</p>",
          "required" : false,
          "type" : "string"
        } ],
        "responses" : {
          "200" : {
            "description" : "Successfully retrieved IP addresses",
            "schema" : {
              "$ref" : "#/definitions/IpAddressesAggregation"
            }
          },
          "400" : {
            "description" : "Bad Request",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "500" : {
            "description" : "IP addresses retrieval failed (error message provided)",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          }
        }
      }
    },
    "/nsa/api/v2_0/alarms/filter/macAddressesAggregations" : {
      "get" : {
        "tags" : [ "Search and filter alarms (version 2)" ],
        "summary" : "Query for MAC addresses in context. Returns a subset of the total MAC addresses in the system.",
        "description" : "Returned in JSON format.",
        "operationId" : "getMacAddresses",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "filter[macAddress]",
          "in" : "query",
          "description" : "Partial MAC address filter value with a minimum of 3 characters.<p>**Example**: _00-04-DC_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "selected[macAddress][]",
          "in" : "query",
          "description" : "Case sensitive MAC address values as a comma separated list.<p>**Example**: _00-04-DC-01-02-03, 00-04-DC-01-02-04_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[contextState][]",
          "in" : "query",
          "description" : "State values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _ACTIVE, CLEARED, SUPERSEDED_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[keytext]",
          "in" : "query",
          "description" : "Key text, minimum 3 characters, to be present in the supported alarm fields.<p>Supported fields include: _condition-severity, device-name, device-long-name, resource, acknowledge-state, native-condition-type, additional-text_, and _service-affecting_.</p><p>Several operators are available including '+' (AND), '|' (OR), '-' (negate).</p><p>Spaces are considered to be OR by default.</p><p>Results without this key text will not be shown in the results context aggregations meta.</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[lastRaisedTime]",
          "in" : "query",
          "description" : "Comma separated last raised time range in the format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T00:00:00.000, 2999-12-31T23:59:59.999_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[clearTime]",
          "in" : "query",
          "description" : "Comma separated clear time range in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T0:0:0.000, 2999-12-31T23:59:59.999_</p>",
          "required" : false,
          "type" : "string"
        } ],
        "responses" : {
          "200" : {
            "description" : "Successfully retrieved MAC addresses",
            "schema" : {
              "$ref" : "#/definitions/MacAddressesAggregation"
            }
          },
          "400" : {
            "description" : "Bad Request",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "500" : {
            "description" : "MAC addresses retrieval failed (error message provided)",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          }
        }
      }
    },
    "/nsa/api/v2_0/alarms/filter/nativeConditionTypeAggregations" : {
      "get" : {
        "tags" : [ "Search and filter alarms (version 2)" ],
        "summary" : "Query for native condition types in context. Returns a subset of the total native condition types in the system.",
        "description" : "Returned in JSON format.",
        "operationId" : "getNativeConditionTypes",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "filter[nativeConditionType]",
          "in" : "query",
          "description" : "Partial native condition type filter value with a minimum of 3 characters.<p>**Example**: _TEX_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "selected[nativeConditionType][]",
          "in" : "query",
          "description" : "Native condition type values as a comma separated list.<p>**Example**: _TYPE1, TYPE2_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[contextState][]",
          "in" : "query",
          "description" : "State values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _ACTIVE, CLEARED, SUPERSEDED_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[keytext]",
          "in" : "query",
          "description" : "Key text, minimum 3 characters, to be present in the supported alarm fields.<p>Supported fields include: _condition-severity, device-name, device-long-name, resource, acknowledge-state, native-condition-type, additional-text_, and _service-affecting_.</p><p>Several operators are available including '+' (AND), '|' (OR), '-' (negate).</p><p>Spaces are considered to be OR by default.</p><p>Results without this key text will not be shown in the results context aggregations meta.</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[lastRaisedTime]",
          "in" : "query",
          "description" : "Comma separated last raised time range in the format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T00:00:00.000, 2999-12-31T23:59:59.999_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[clearTime]",
          "in" : "query",
          "description" : "Comma separated clear time range in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T0:0:0.000, 2999-12-31T23:59:59.999_</p>",
          "required" : false,
          "type" : "string"
        } ],
        "responses" : {
          "200" : {
            "description" : "Successfully retrieved additional texts",
            "schema" : {
              "$ref" : "#/definitions/NativeConditionTypesAggregation"
            }
          },
          "400" : {
            "description" : "Bad Request",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "500" : {
            "description" : "Native condition types retrieval failed (error message provided)",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          }
        }
      }
    },
    "/nsa/api/v2_0/alarms/filter/nextScrollFilteredAlarms" : {
      "get" : {
        "tags" : [ "Search and filter alarms (version 2)" ],
        "summary" : "Search/Filter all Alarms on the system.",
        "description" : "List of filtered Alarms returned in JSON format.",
        "operationId" : "nextFilteredAlarms",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "scrollId",
          "in" : "query",
          "description" : "Scroll id returned from startScrollFilteredAlarm call.DnF1ZXJ5VGhlbkZldGNoAwAAAAAAADG0FmNTcGcweHJtUWVPeE5CN3ZNYm5CQVEAAAAAAAAxtRZjU3BnMHhybVFlT3hOQjd2TWJuQkFRAAAAAAAAMbYWY1NwZzB4cm1RZU94TkI3dk1ibkJBUQ==",
          "required" : true,
          "type" : "string"
        }, {
          "name" : "scrollTimeout",
          "in" : "query",
          "description" : "Timeout of scroll in second. If the next scroll search is not issued in time, the scroll will expire.",
          "required" : false,
          "type" : "string",
          "default" : "300"
        } ],
        "responses" : {
          "200" : {
            "description" : "Successfully retrieved next filtered alarm list",
            "schema" : {
              "$ref" : "#/definitions/FilteredAlarmsByScroll"
            }
          },
          "400" : {
            "description" : "Bad request",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "500" : {
            "description" : "Retrieval of next filtered alarm list failed (error message provided)",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          }
        }
      }
    },
    "/nsa/api/v2_0/alarms/filter/resourceAggregations" : {
      "get" : {
        "tags" : [ "Search and filter alarms (version 2)" ],
        "summary" : "Query for resources in context. Returns a subset of the total resources in the system.",
        "description" : "Returned in JSON format.",
        "operationId" : "getResources",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "filter[resource]",
          "in" : "query",
          "description" : "Partial resource filter value with a minimum of 1 character.<p>**Example**: _RES_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "selected[resource][]",
          "in" : "query",
          "description" : "Resource values as a comma separated list.<p>**Example**: _RESOURCE1, RESOURCE2_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[contextState][]",
          "in" : "query",
          "description" : "State values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _ACTIVE, CLEARED, SUPERSEDED_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[keytext]",
          "in" : "query",
          "description" : "Key text, minimum 3 characters, to be present in the supported alarm fields.<p>Supported fields include: _condition-severity, device-name, device-long-name, resource, acknowledge-state, native-condition-type, additional-text_, and _service-affecting_.</p><p>Several operators are available including '+' (AND), '|' (OR), '-' (negate).</p><p>Spaces are considered to be OR by default.</p><p>Results without this key text will not be shown in the results context aggregations meta.</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[lastRaisedTime]",
          "in" : "query",
          "description" : "Comma separated last raised time range in the format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T00:00:00.000, 2999-12-31T23:59:59.999_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[clearTime]",
          "in" : "query",
          "description" : "Comma separated clear time range in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T0:0:0.000, 2999-12-31T23:59:59.999_</p>",
          "required" : false,
          "type" : "string"
        } ],
        "responses" : {
          "200" : {
            "description" : "Successfully retrieved resources",
            "schema" : {
              "$ref" : "#/definitions/ResourcesAggregation"
            }
          },
          "400" : {
            "description" : "Bad Request",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "500" : {
            "description" : "Resources retrieval failed (error message provided)",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          }
        }
      }
    },
    "/nsa/api/v2_0/alarms/filter/startScrollFilteredAlarms" : {
      "post" : {
        "tags" : [ "Search and filter alarms (version 2)" ],
        "summary" : "Start a scroll search/Filter all Alarms on the system.",
        "description" : "List of filtered Alarms returned in JSON format and scroll id",
        "operationId" : "scrollSearchFilteredAlarms",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "filter[alarmId][]",
          "in" : "query",
          "description" : "Alarm id values as a comma separated list.<p>**Example**: _ID1, ID2_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[state][]",
          "in" : "query",
          "description" : "State values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _ACTIVE, CLEARED, SUPERSEDED_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[severity][]",
          "in" : "query",
          "description" : "Severity values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>**Example**: _CRITICAL, MAJOR, MINOR, WARNING_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[serviceAffecting][]",
          "in" : "query",
          "description" : "Service affecting values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>**Example**: _SERVICE_AFFECTING, NON_SERVICE_AFFECTING_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[deviceType][]",
          "in" : "query",
          "description" : "Device type values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>**Example**: _6500, OPENSTACK, NUAGE_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[acknowledgeState][]",
          "in" : "query",
          "description" : "Acknowledgment state values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>**Example**: _ACKNOWLEDGED, NOT_ACKNOWLEDGED_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[deviceId][]",
          "in" : "query",
          "description" : "Device id values as a comma separated list.<p>**Example**: _ID1, ID2_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[deviceName][]",
          "in" : "query",
          "description" : "Case sensitive device name values as a comma separated list.<p>**Example**: _NAME1, NAME2_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[ipAddress][]",
          "in" : "query",
          "description" : "IP address values as a comma separated list.<p>**Example**: _192.168.42.2, 192.168.42.3_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[macAddress][]",
          "in" : "query",
          "description" : "Case sensitive MAC address values as a comma separated list.<p>**Example**: _00-04-DC-01-02-03, 00-04-DC-01-02-04_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[additionalText][]",
          "in" : "query",
          "description" : "Additional text values as a comma separated list.<p>**Example**: _TEXT1, TEXT2_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[nativeConditionType][]",
          "in" : "query",
          "description" : "Native condition type values as a comma separated list.<p>**Example**: _TYPE1, TYPE2_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[resource][]",
          "in" : "query",
          "description" : "Resource values as a comma separated list.<p>**Example**: _RESOURCE1, RESOURCE2_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[resourceId][]",
          "in" : "query",
          "description" : "Resource ID values as a comma separated list.<p>**Example**: _RESOURCEID1, RESOURCEID2_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[subnetName][]",
          "in" : "query",
          "description" : "Case sensitive subnet name values as a comma separated list.<p>**Example**: _SUBNET01, SUBNET02_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[cardType][]",
          "in" : "query",
          "description" : "Card type values as a comma separated list.<p>**Example**: _SP-2_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[clfi][]",
          "in" : "query",
          "description" : "CLFI values as a comma separated list.<p>**Example**: _CLFI01, CLFI02_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[fic][]",
          "in" : "query",
          "description" : "FIC values as a comma separated list.<p>**Example**: _FIC01, FIC02_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[keytext]",
          "in" : "query",
          "description" : "Key text, minimum 3 characters, to be present in the supported alarm fields.<p>Supported fields include: _condition-severity, device-name, device-long-name, resource, acknowledge-state, native-condition-type, additional-text_, and _service-affecting_.</p><p>Several operators are available including '+' (AND), '|' (OR), '-' (negate).</p><p>Spaces are considered to be OR by default.</p><p>Results without this key text will not be shown in the results context aggregations meta.</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[lastRaisedTime]",
          "in" : "query",
          "description" : "Comma separated last raised time range in the format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T00:00:00.000, 2999-12-31T23:59:59.999_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[lastRaisedTimeFrom]",
          "in" : "query",
          "description" : "Last raised time to be searched after in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T00:00:00.000_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[lastRaisedTimeTo]",
          "in" : "query",
          "description" : "Last raised time to be searched before in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _2999-12-31T23:59:59.999_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[clearTime]",
          "in" : "query",
          "description" : "Comma separated clear time range in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T0:0:0.000, 2999-12-31T23:59:59.999_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[clearTimeFrom]",
          "in" : "query",
          "description" : "Last clear time to be searched after in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T00:00:00.000_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[clearTimeTo]",
          "in" : "query",
          "description" : "Last clear time to be searched before in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _2999-12-31T23:59:59.999_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[refinedRaisedTimeFrom]",
          "in" : "query",
          "description" : "Refined raised time to be searched after in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>**Example**: _1900-01-01T00:00:00.000_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[refinedRaisedTimeTo]",
          "in" : "query",
          "description" : "Refined raised time to be searched before in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>**Example**: _2999-12-31T23:59:59.999_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[refinedClearTimeFrom]",
          "in" : "query",
          "description" : "Refined cleared time to be searched after in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>**Example**: _1900-01-01T00:00:00.000_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[refinedClearTimeTo]",
          "in" : "query",
          "description" : "Refined clear time to be searched before in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>**Example**: _2999-12-31T23:59:59.999_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "scrollTimeout",
          "in" : "query",
          "description" : "Timeout of scroll in second. If the next scroll search is not issued in time, the scroll will expire.",
          "required" : false,
          "type" : "string",
          "default" : "300"
        }, {
          "name" : "scrollSize",
          "in" : "query",
          "description" : "Limit of the number of alarms returned per scroll search. Only specify in the first scroll call.",
          "required" : false,
          "type" : "string",
          "default" : "500"
        } ],
        "responses" : {
          "200" : {
            "description" : "successful operation",
            "schema" : {
              "$ref" : "#/definitions/FilteredAlarmsByScroll"
            }
          },
          "201" : {
            "description" : "Successfully started a scroll filter search of alarms",
            "schema" : {
              "$ref" : "#/definitions/FilteredAlarmsByScroll"
            }
          },
          "400" : {
            "description" : "Bad request",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "500" : {
            "description" : "Scroll filter search of alarms failed (error message provided)",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          }
        }
      }
    },
    "/nsa/api/v2_0/alarms/filter/subnetNamesAggregations" : {
      "get" : {
        "tags" : [ "Search and filter alarms (version 2)" ],
        "summary" : "Query for subnet names in context. Returns a subset of the total subnet names in the system.",
        "description" : "Returned in JSON format.",
        "operationId" : "getSubnetNames",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "filter[subnetName]",
          "in" : "query",
          "description" : "Partial case sensitive subnet name filter value with a minimum of 3 characters.<p>**Example**: _NAME1_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "selected[subnetName][]",
          "in" : "query",
          "description" : "Case sensitive subnet name values as a comma separated list.<p>**Example**: _NAME1, NAME2_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[contextState][]",
          "in" : "query",
          "description" : "State values as a comma separated list or in new lines.<p>The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...</p><p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _ACTIVE, CLEARED, SUPERSEDED_</p>",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        }, {
          "name" : "filter[keytext]",
          "in" : "query",
          "description" : "Key text, minimum 3 characters, to be present in the supported alarm fields.<p>Supported fields include: _condition-severity, device-name, device-long-name, resource, acknowledge-state, native-condition-type, additional-text_, and _service-affecting_.</p><p>Several operators are available including '+' (AND), '|' (OR), '-' (negate).</p><p>Spaces are considered to be OR by default.</p><p>Results without this key text will not be shown in the results context aggregations meta.</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[lastRaisedTime]",
          "in" : "query",
          "description" : "Comma separated last raised time range in the format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T00:00:00.000, 2999-12-31T23:59:59.999_</p>",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter[clearTime]",
          "in" : "query",
          "description" : "Comma separated clear time range in format: _yyyy-MM-ddTHH:mm:ss.SSS_.<p>Results outside of this range will not be shown in the context aggregations meta.</p><p>**Example**: _1900-01-01T0:0:0.000, 2999-12-31T23:59:59.999_</p>",
          "required" : false,
          "type" : "string"
        } ],
        "responses" : {
          "200" : {
            "description" : "Successfully retrieved subnet names",
            "schema" : {
              "$ref" : "#/definitions/SubnetNamesAggregation"
            }
          },
          "400" : {
            "description" : "Bad Request",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "500" : {
            "description" : "Subnet names retrieval failed (error message provided)",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          }
        }
      }
    },
    "/nsa/api/v2_0/alarms/filter/{channel}" : {
      "delete" : {
        "tags" : [ "Search and filter alarms (version 2)" ],
        "summary" : "Manually delete an alarm filter from the system by filter channel.",
        "description" : "Use caution when using this REST API. Active subscribers will no longer receive alarm notifications for their filter and may begin receiving notifications for a new filter.",
        "operationId" : "deleteFilter",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "channel",
          "in" : "path",
          "description" : "The channel attribute of the filter to delete",
          "required" : true,
          "type" : "string"
        } ],
        "responses" : {
          "204" : {
            "description" : "Successfully deleted alarm filter"
          },
          "404" : {
            "description" : "Alarm filter not found",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "500" : {
            "description" : "Alarm filter deletion failed",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          }
        }
      }
    },
    "/nsa/api/v2_0/alarms/resetRequestId/{serverId}" : {
      "post" : {
        "tags" : [ "Retrieve and modify alarms (version 2)" ],
        "summary" : "Reset request IDs for all alarms/events for this server ID to zero",
        "description" : "Reset request IDs for all alarms/events for this server ID to zero in order to recover from an early request ID roll over",
        "operationId" : "resetRequestIdsForServerId",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "serverId",
          "in" : "path",
          "description" : "Requested node Identifier.",
          "required" : true,
          "type" : "string"
        } ],
        "responses" : {
          "204" : {
            "description" : "Successfully reset request IDs"
          },
          "400" : {
            "description" : "Bad Request",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "500" : {
            "description" : "Failed to reset request IDs (error message provided)",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          }
        }
      }
    },
    "/nsa/api/v2_0/alarms/{Id}/acknowledge/{sequenceId}" : {
      "post" : {
        "tags" : [ "Retrieve and modify alarms (version 2)" ],
        "summary" : "Acknowledge an active alarm based on its identifier.",
        "description" : "Only active Alarms can be acknowledged.",
        "operationId" : "acknowledgeAlarm",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "Id",
          "in" : "path",
          "description" : "Identifier of the alarm to be marked as _acknowledged_.",
          "required" : true,
          "type" : "string"
        }, {
          "name" : "sequenceId",
          "in" : "path",
          "description" : "The alarm's last raise time in milliseconds.",
          "required" : true,
          "type" : "string"
        } ],
        "responses" : {
          "204" : {
            "description" : "Successfully acknowledged alarm"
          },
          "400" : {
            "description" : "Bad Request",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "404" : {
            "description" : "Alarm not found",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "500" : {
            "description" : "Acknowledging a specific active alarm failed (error message provided)",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          }
        }
      }
    },
    "/nsa/api/v2_0/alarms/{Id}/force-clear/{sequenceId}" : {
      "post" : {
        "tags" : [ "Retrieve and modify alarms (version 2)" ],
        "summary" : "Force clear an active alarm based on its identifier (irrespective of its clearable flag).",
        "description" : "Never use this REST API unless you have no other option.",
        "operationId" : "forceClearAlarm",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "Id",
          "in" : "path",
          "description" : "Identifier of the alarm to be marked as _cleared_.",
          "required" : true,
          "type" : "string"
        }, {
          "name" : "sequenceId",
          "in" : "path",
          "description" : "The alarm's last raise time in milliseconds.",
          "required" : true,
          "type" : "string"
        } ],
        "responses" : {
          "204" : {
            "description" : "Successfully force cleared alarm"
          },
          "400" : {
            "description" : "Bad Request",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "404" : {
            "description" : "Alarm not found",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "500" : {
            "description" : "Clearing a specific active alarm failed (error message provided)",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          }
        }
      }
    },
    "/nsa/api/v2_0/alarms/{Id}/manual-clear/{sequenceId}" : {
      "post" : {
        "tags" : [ "Retrieve and modify alarms (version 2)" ],
        "summary" : "Manually clear an active alarm based on its identifier.",
        "description" : "Only manually clearable alarms can be cleared.",
        "operationId" : "manualClearAlarm",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "Id",
          "in" : "path",
          "description" : "Identifier of the alarm to be marked as _cleared_.",
          "required" : true,
          "type" : "string"
        }, {
          "name" : "sequenceId",
          "in" : "path",
          "description" : "The alarm's last raise time in milliseconds.",
          "required" : true,
          "type" : "string"
        } ],
        "responses" : {
          "204" : {
            "description" : "Successfully manually cleared alarm"
          },
          "400" : {
            "description" : "Bad Request",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "404" : {
            "description" : "Alarm not found",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "500" : {
            "description" : "Clearing a specific active alarm failed (error message provided)",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          }
        }
      }
    },
    "/nsa/api/v2_0/alarms/{Id}/unacknowledge/{sequenceId}" : {
      "post" : {
        "tags" : [ "Retrieve and modify alarms (version 2)" ],
        "summary" : "Unacknowledge an active alarm based on its identifier.",
        "description" : "Only active Alarms can be unacknowledged.",
        "operationId" : "unacknowledgeAlarm",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "Id",
          "in" : "path",
          "description" : "Identifier of the alarm to be marked as _unacknowledged_.",
          "required" : true,
          "type" : "string"
        }, {
          "name" : "sequenceId",
          "in" : "path",
          "description" : "The alarm's last raise time in milliseconds.",
          "required" : true,
          "type" : "string"
        } ],
        "responses" : {
          "204" : {
            "description" : "Successfully un-acknowledged alarm"
          },
          "400" : {
            "description" : "Bad Request",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "404" : {
            "description" : "Alarm not found",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          },
          "500" : {
            "description" : "Un-acknowledging a specific active alarm failed (error message provided)",
            "schema" : {
              "$ref" : "#/definitions/Errors"
            }
          }
        }
      }
    }
  },
  "definitions" : {
    "AcknowledgeState" : {
      "type" : "object"
    },
    "ActiveAlarms" : {
      "type" : "object",
      "properties" : {
        "data" : {
          "type" : "array",
          "items" : {
            "$ref" : "#/definitions/ActiveAlarmsData"
          }
        },
        "meta" : {
          "$ref" : "#/definitions/FilteredAlarmsMeta"
        },
        "links" : {
          "$ref" : "#/definitions/FilteredAlarmsLinks"
        }
      }
    },
    "ActiveAlarmsAttributes" : {
      "type" : "object",
      "properties" : {
        "id" : {
          "type" : "string",
          "description" : "The alarm id"
        },
        "node-id" : {
          "type" : "string",
          "description" : "The unique ID associated with the node/device provided by the RA"
        },
        "node-type" : {
          "type" : "string",
          "description" : "The type of node/device, e.g. 6500"
        },
        "resource" : {
          "type" : "string",
          "description" : "The location and equipment type"
        },
        "native-condition-type" : {
          "type" : "string",
          "description" : "The native condition or alarm name"
        },
        "condition-severity" : {
          "type" : "string",
          "description" : "The severity of the alarm",
          "enum" : [ "CRITICAL", "MAJOR", "MINOR", "WARNING", "INDETERMINATE", "INFO", "CONFIG", "DEBUG" ]
        },
        "service-affecting" : {
          "type" : "string",
          "description" : "The service impact of the alarm",
          "enum" : [ "UNKNOWN", "SERVICE_AFFECTING", "NON_SERVICE_AFFECTING" ]
        },
        "manual-clearable" : {
          "type" : "boolean",
          "description" : "Whether or not the alarm can be cleared manually",
          "default" : false
        },
        "additional-text" : {
          "type" : "string",
          "description" : "Additional information about the alarm"
        },
        "first-raise-time" : {
          "type" : "string",
          "format" : "date-time",
          "description" : "The date and time that the alarm was first raised"
        },
        "last-raise-time" : {
          "type" : "string",
          "format" : "date-time",
          "description" : "The date and time that the alarm was last raised"
        },
        "acknowledge-update-time" : {
          "type" : "string",
          "format" : "date-time",
          "description" : "The date and time that the alarms acknowledge state last changed"
        },
        "acknowledge-update-user" : {
          "type" : "string",
          "description" : "The user that last updated the acknowledge state the alarm"
        },
        "number-of-occurrences" : {
          "type" : "integer",
          "format" : "int64",
          "description" : "The number of times the alarm has occurred"
        },
        "acknowledge-state" : {
          "type" : "string",
          "description" : "The acknowledge state of the alarm",
          "enum" : [ "NOT_ACKNOWLEDGED", "ACKNOWLEDGED" ]
        },
        "device-name" : {
          "type" : "string",
          "description" : "Device's name."
        },
        "ip-address" : {
          "type" : "string",
          "description" : "Device's IP address."
        },
        "mac-address" : {
          "type" : "string",
          "description" : "Device's Mac address."
        },
        "device-attributes" : {
          "description" : "Device specific attributes for the alarm",
          "$ref" : "#/definitions/Device_attributes"
        }
      }
    },
    "ActiveAlarmsData" : {
      "type" : "object",
      "properties" : {
        "id" : {
          "type" : "string",
          "description" : "The unique identifier for the alarm"
        },
        "type" : {
          "type" : "string",
          "enum" : [ "ActiveAlarm" ]
        },
        "attributes" : {
          "$ref" : "#/definitions/ActiveAlarmsAttributes"
        }
      }
    },
    "AdditionalText" : {
      "type" : "object",
      "properties" : {
        "value" : {
          "type" : "string"
        },
        "count" : {
          "type" : "integer",
          "format" : "int64"
        }
      }
    },
    "AdditionalTextsAggregation" : {
      "type" : "object",
      "properties" : {
        "data" : {
          "$ref" : "#/definitions/AdditionalTextsAggregationData"
        }
      }
    },
    "AdditionalTextsAggregationAttributes" : {
      "type" : "object",
      "properties" : {
        "additionalTexts" : {
          "type" : "array",
          "items" : {
            "$ref" : "#/definitions/AdditionalText"
          }
        }
      }
    },
    "AdditionalTextsAggregationData" : {
      "type" : "object",
      "properties" : {
        "id" : {
          "type" : "string"
        },
        "type" : {
          "type" : "string",
          "enum" : [ "AdditionalTextsAggregation" ]
        },
        "attributes" : {
          "$ref" : "#/definitions/AdditionalTextsAggregationAttributes"
        }
      }
    },
    "Additional_attrs" : {
      "type" : "object"
    },
    "AlarmQueryList" : {
      "type" : "object",
      "properties" : {
        "ids" : {
          "type" : "array",
          "items" : {
            "type" : "string"
          }
        }
      }
    },
    "DeviceAttributesAttributesRO" : {
      "type" : "object",
      "properties" : {
        "id" : {
          "type" : "string",
          "description" : "The device session ID"
        },
        "deviceId" : {
          "type" : "string",
          "description" : "The device ID"
        },
        "deviceName" : {
          "type" : "string",
          "description" : "Device primary identifier. Will be shown below the alarm name"
        },
        "deviceLongName" : {
          "type" : "string",
          "description" : "Device long identifier."
        },
        "deviceLocation" : {
          "type" : "string",
          "description" : "Geo hash location of the device."
        },
        "ipAddress" : {
          "type" : "string",
          "description" : "Device secondary identifier. Will be shown below the primary identifier in the expanded view."
        },
        "macAddress" : {
          "type" : "string",
          "description" : "Device tertiary identifier. Will be shown below the secondary identifier in the expanded view."
        },
        "partition" : {
          "type" : "array",
          "description" : "The partitions that the device belongs to.",
          "items" : {
            "type" : "string"
          }
        }
      }
    },
    "DeviceAttributesDataRO" : {
      "type" : "object",
      "properties" : {
        "id" : {
          "type" : "string",
          "description" : "Unique device ID matching that provided from the device resource adapter in the alarm record"
        },
        "type" : {
          "type" : "string",
          "description" : "Device attributes type",
          "enum" : [ "deviceAttributes" ]
        },
        "attributes" : {
          "$ref" : "#/definitions/DeviceAttributesAttributesRO"
        }
      }
    },
    "DeviceAttributesRO" : {
      "type" : "object",
      "properties" : {
        "data" : {
          "$ref" : "#/definitions/DeviceAttributesDataRO"
        }
      }
    },
    "DeviceId" : {
      "type" : "object"
    },
    "DeviceName" : {
      "type" : "object"
    },
    "DeviceNamesAggregation" : {
      "type" : "object",
      "properties" : {
        "data" : {
          "$ref" : "#/definitions/DeviceNamesAggregationData"
        }
      }
    },
    "DeviceNamesAggregationAttributes" : {
      "type" : "object",
      "properties" : {
        "deviceNames" : {
          "type" : "array",
          "items" : {
            "$ref" : "#/definitions/DeviceName"
          }
        }
      }
    },
    "DeviceNamesAggregationData" : {
      "type" : "object",
      "properties" : {
        "id" : {
          "type" : "string"
        },
        "type" : {
          "type" : "string",
          "enum" : [ "DeviceNamesAggregation" ]
        },
        "attributes" : {
          "$ref" : "#/definitions/DeviceNamesAggregationAttributes"
        }
      }
    },
    "DeviceType" : {
      "type" : "object"
    },
    "DeviceTypesRO" : {
      "type" : "object",
      "properties" : {
        "data" : {
          "type" : "array",
          "items" : {
            "$ref" : "#/definitions/ResourceObjectDeviceType"
          }
        },
        "links" : {
          "type" : "object",
          "additionalProperties" : {
            "$ref" : "#/definitions/LinksObject"
          }
        },
        "meta" : {
          "type" : "object",
          "additionalProperties" : {
            "type" : "object"
          }
        }
      }
    },
    "Device_attributes" : {
      "type" : "object"
    },
    "Device_attributes__" : {
      "type" : "object"
    },
    "Error" : {
      "type" : "object",
      "properties" : {
        "errorCode" : {
          "type" : "string"
        },
        "errorMessage" : {
          "type" : "string"
        },
        "errorDescription" : {
          "type" : "string"
        },
        "msgAttributes" : {
          "type" : "object",
          "additionalProperties" : {
            "type" : "object"
          }
        },
        "meta" : {
          "type" : "array",
          "items" : {
            "type" : "object"
          }
        }
      }
    },
    "Errors" : {
      "type" : "object",
      "properties" : {
        "errors" : {
          "type" : "array",
          "items" : {
            "$ref" : "#/definitions/Error"
          }
        }
      }
    },
    "Filter" : {
      "type" : "object",
      "properties" : {
        "data" : {
          "$ref" : "#/definitions/FilterData"
        }
      }
    },
    "FilterAttributes" : {
      "type" : "object",
      "properties" : {
        "channel" : {
          "type" : "string",
          "description" : "The channel on which to subscribe for notifications. E.g. via Kafka Comet"
        },
        "latestOffset" : {
          "type" : "integer",
          "format" : "int64",
          "description" : "The latest message offset for the associated channel. If the offset cannot be retrieved it will be set to -9999, in that case please use the latest offset"
        },
        "nodeType" : {
          "type" : "array",
          "description" : "The type of node/device, e.g. CN6500, case insensitive exact match only",
          "items" : {
            "type" : "string"
          }
        },
        "resource" : {
          "type" : "array",
          "description" : "Regular expression for the location and equipment type. E.g. 40GMUX.* for all 40GMUX on any shelf and slot",
          "items" : {
            "type" : "string"
          }
        },
        "nativeConditionType" : {
          "type" : "array",
          "description" : "The native condition or alarm name, case insensitive exact match only",
          "items" : {
            "type" : "string"
          }
        },
        "nativeConditionTypeExclusion" : {
          "type" : "array",
          "description" : "The native condition or alarm name for exclusion, case insensitive substring match supported",
          "items" : {
            "type" : "string"
          }
        },
        "severity" : {
          "type" : "array",
          "description" : "The severity of the alarm, case insensitive exact match only. Allowable values: indeterminate, critical, major, minor, warning, config, info",
          "items" : {
            "type" : "string"
          }
        },
        "serviceAffecting" : {
          "type" : "array",
          "description" : "The service impact of the alarm, case insensitive exact match only. Allowable values: service_affecting, non_service_affecting, unknown",
          "items" : {
            "type" : "string"
          }
        },
        "additionalText" : {
          "type" : "array",
          "description" : "Additional information about the alarm, case insensitive substring match supported",
          "items" : {
            "type" : "string"
          }
        },
        "additionalTextExclusion" : {
          "type" : "array",
          "description" : "Additional information about the alarm for exclusion, case insensitive substring match supported",
          "items" : {
            "type" : "string"
          }
        },
        "raiseTimeHour" : {
          "type" : "array",
          "description" : "A GMT 24-hour range to allow notifications to pass through. E.g. 09-17 will pass all alarms with raise times between 9:00.000 AM and 4:59.999 PM GMT",
          "items" : {
            "type" : "string"
          }
        },
        "maxOccurrences" : {
          "type" : "integer",
          "format" : "int64",
          "description" : "Pass through alarms with less than or equal to this number of occurrences. E.g. 100 would filter out any alarms with 101 or more occurrences"
        },
        "deviceName" : {
          "type" : "array",
          "description" : "A device's name, case insensitive exact match only",
          "items" : {
            "type" : "string"
          }
        },
        "deviceNameExclusion" : {
          "type" : "array",
          "description" : "A device's name for exclusion, case insensitive substring match supported",
          "items" : {
            "type" : "string"
          }
        },
        "ipAddress" : {
          "type" : "array",
          "description" : "A device's IP address, exact match only",
          "items" : {
            "type" : "string"
          }
        },
        "ipAddressExclusion" : {
          "type" : "array",
          "description" : "A device's IP address for exclusion, exact match only",
          "items" : {
            "type" : "string"
          }
        },
        "partition" : {
          "type" : "array",
          "description" : "The partitions of the user who creates the filter",
          "items" : {
            "type" : "string"
          }
        }
      }
    },
    "FilterData" : {
      "type" : "object",
      "properties" : {
        "id" : {
          "type" : "string",
          "description" : "The unique identifier for the alarm filter"
        },
        "type" : {
          "type" : "string",
          "enum" : [ "Filter" ]
        },
        "attributes" : {
          "$ref" : "#/definitions/FilterAttributes"
        }
      }
    },
    "FilteredAlarm" : {
      "type" : "object",
      "properties" : {
        "data" : {
          "$ref" : "#/definitions/FilteredAlarmsData"
        }
      }
    },
    "FilteredAlarms" : {
      "type" : "object",
      "properties" : {
        "data" : {
          "type" : "array",
          "items" : {
            "$ref" : "#/definitions/FilteredAlarmsData"
          }
        },
        "meta" : {
          "$ref" : "#/definitions/FilteredAlarmsMeta"
        },
        "links" : {
          "$ref" : "#/definitions/FilteredAlarmsLinks"
        }
      }
    },
    "FilteredAlarmsAttributes" : {
      "type" : "object",
      "properties" : {
        "id" : {
          "type" : "string",
          "description" : "The alarm id"
        },
        "alarm-id" : {
          "type" : "string",
          "description" : "The original alarm id of the historical alarm"
        },
        "node-id" : {
          "type" : "string",
          "description" : "The unique ID associated with the node/device provided by the RA"
        },
        "ra-alarm-id" : {
          "type" : "string",
          "description" : "The RA Alarm identifier"
        },
        "node-type" : {
          "type" : "string",
          "description" : "The type of node/device, e.g. 6500"
        },
        "state" : {
          "type" : "string",
          "description" : "The alarm state",
          "enum" : [ "ACTIVE", "CLEARED", "SUPERSEDED" ]
        },
        "resource" : {
          "type" : "string",
          "description" : "The location and equipment type"
        },
        "resource-id" : {
          "type" : "string",
          "description" : "The a unique id of the resource sending the alarm"
        },
        "native-condition-type" : {
          "type" : "string",
          "description" : "The native condition or alarm name"
        },
        "condition-severity" : {
          "type" : "string",
          "description" : "The severity of the alarm",
          "enum" : [ "CRITICAL", "MAJOR", "MINOR", "WARNING", "INDETERMINATE", "INFO", "CONFIG", "DEBUG" ]
        },
        "service-affecting" : {
          "type" : "string",
          "description" : "The service impact of the alarm",
          "enum" : [ "UNKNOWN", "SERVICE_AFFECTING", "NON_SERVICE_AFFECTING" ]
        },
        "native-state" : {
          "type" : "string",
          "description" : "The native state"
        },
        "native-name" : {
          "type" : "string",
          "description" : "The native name"
        },
        "native-description" : {
          "type" : "string",
          "description" : "The native description"
        },
        "manual-clearable" : {
          "type" : "boolean",
          "description" : "Whether or not the alarm can be cleared manually",
          "default" : false
        },
        "additional-text" : {
          "type" : "string",
          "description" : "Additional information about the alarm"
        },
        "first-raise-time" : {
          "type" : "string",
          "format" : "date-time",
          "description" : "The date and time that the alarm was first raised"
        },
        "last-raise-time" : {
          "type" : "string",
          "format" : "date-time",
          "description" : "The date and time that the alarm was last raised"
        },
        "clear-time" : {
          "type" : "string",
          "format" : "date-time",
          "description" : "The date and time that the alarm was cleared"
        },
        "supersede-time" : {
          "type" : "string",
          "format" : "date-time",
          "description" : "The date and time that the alarm was superseded"
        },
        "acknowledge-update-time" : {
          "type" : "string",
          "format" : "date-time",
          "description" : "The date and time that the alarms acknowledge state last changed"
        },
        "clear-user" : {
          "type" : "string",
          "description" : "The user that cleared the alarm"
        },
        "acknowledge-update-user" : {
          "type" : "string",
          "description" : "The user that last updated the acknowledge state the alarm"
        },
        "number-of-occurrences" : {
          "type" : "integer",
          "format" : "int64",
          "description" : "The number of times the alarm has occurred"
        },
        "acknowledge-state" : {
          "type" : "string",
          "description" : "The acknowledge state of the alarm",
          "enum" : [ "NOT_ACKNOWLEDGED", "ACKNOWLEDGED" ]
        },
        "device-id" : {
          "type" : "string",
          "description" : "Device's id."
        },
        "device-name" : {
          "type" : "string",
          "description" : "Device's name."
        },
        "device-long-name" : {
          "type" : "string",
          "description" : "Device's long name."
        },
        "ip-address" : {
          "type" : "string",
          "description" : "Device's IP address."
        },
        "mac-address" : {
          "type" : "string",
          "description" : "Device's Mac address."
        },
        "subnet-name" : {
          "type" : "string",
          "description" : "Device's subnet name."
        },
        "card-type" : {
          "type" : "string",
          "description" : "Card type."
        },
        "clfi" : {
          "type" : "string",
          "description" : "Common language facility identifier."
        },
        "fic" : {
          "type" : "string",
          "description" : "Frame identification code."
        },
        "partition" : {
          "type" : "array",
          "description" : "The partitions that the device belongs to.",
          "items" : {
            "type" : "string"
          }
        },
        "device-tags" : {
          "type" : "array",
          "description" : "A list of tags for a given device.",
          "items" : {
            "type" : "string"
          }
        },
        "device-attributes" : {
          "description" : "Device specific attributes for the alarm",
          "$ref" : "#/definitions/Device_attributes"
        },
        "additional-attrs" : {
          "description" : "Additional attributes for the alarm",
          "$ref" : "#/definitions/Additional_attrs"
        },
        "affected-inventory-ids" : {
          "type" : "array",
          "description" : "Inventory IDs affected by alarms",
          "items" : {
            "type" : "string"
          }
        },
        "sequence-id" : {
          "type" : "string",
          "description" : "The alarm's sequence ID, the last-raise-time of that alarm instance in long."
        },
        "request-id" : {
          "type" : "string",
          "description" : "The alarm's sequence ID, the last-raise-time of that alarm instance in long."
        }
      }
    },
    "FilteredAlarmsByScroll" : {
      "type" : "object",
      "properties" : {
        "data" : {
          "$ref" : "#/definitions/FilteredAlarms"
        },
        "scrollId" : {
          "type" : "string",
          "description" : "The scroll id"
        }
      }
    },
    "FilteredAlarmsData" : {
      "type" : "object",
      "properties" : {
        "id" : {
          "type" : "string",
          "description" : "The unique identifier for the alarm"
        },
        "type" : {
          "type" : "string",
          "enum" : [ "FilteredAlarm" ]
        },
        "attributes" : {
          "$ref" : "#/definitions/FilteredAlarmsAttributes"
        }
      }
    },
    "FilteredAlarmsLinks" : {
      "type" : "object",
      "properties" : {
        "data" : {
          "$ref" : "#/definitions/FilteredAlarmsLinksNext"
        }
      }
    },
    "FilteredAlarmsLinksMeta" : {
      "type" : "object",
      "properties" : {
        "nextOffset" : {
          "type" : "integer",
          "format" : "int32",
          "description" : "The offset for the next page of results"
        }
      }
    },
    "FilteredAlarmsLinksNext" : {
      "type" : "object",
      "properties" : {
        "href" : {
          "type" : "string",
          "description" : "The href for the next page of results"
        },
        "meta" : {
          "$ref" : "#/definitions/FilteredAlarmsLinksMeta"
        }
      }
    },
    "FilteredAlarmsMeta" : {
      "type" : "object",
      "properties" : {
        "context-total" : {
          "type" : "integer",
          "format" : "int64",
          "description" : "Total records matching the filters in the database"
        },
        "query-total" : {
          "type" : "integer",
          "format" : "int64",
          "description" : "Total records matching the filters in the database"
        },
        "context-aggregations" : {
          "$ref" : "#/definitions/FilteredAlarmsMetaContextAggregations"
        },
        "query-aggregations" : {
          "$ref" : "#/definitions/FilteredAlarmsMetaQueryAggregations"
        }
      }
    },
    "FilteredAlarmsMetaContextAggregations" : {
      "type" : "object",
      "properties" : {
        "state" : {
          "type" : "array",
          "description" : "A map of state values and their counts associated with the context results",
          "items" : {
            "$ref" : "#/definitions/State"
          }
        },
        "severity" : {
          "type" : "array",
          "description" : "A map of severity values and their counts associated with the context results",
          "items" : {
            "$ref" : "#/definitions/Severity"
          }
        },
        "serviceAffecting" : {
          "type" : "array",
          "description" : "A map of service affecting values and their counts associated with the context results",
          "items" : {
            "$ref" : "#/definitions/ServiceAffecting"
          }
        },
        "deviceType" : {
          "type" : "array",
          "description" : "A map of device type values and their counts associated with the context results",
          "items" : {
            "$ref" : "#/definitions/DeviceType"
          }
        },
        "acknowledgeState" : {
          "type" : "array",
          "description" : "A map of acknowledge state values and their counts associated with the context results",
          "items" : {
            "$ref" : "#/definitions/AcknowledgeState"
          }
        },
        "deviceId" : {
          "type" : "array",
          "description" : "A map of device id values and their counts associated with the context results",
          "items" : {
            "$ref" : "#/definitions/DeviceId"
          }
        },
        "deviceName" : {
          "type" : "array",
          "description" : "A map of device name values and their counts associated with the context results",
          "items" : {
            "$ref" : "#/definitions/DeviceName"
          }
        },
        "ipAddress" : {
          "type" : "array",
          "description" : "A map of IP address values and their counts associated with the context results",
          "items" : {
            "$ref" : "#/definitions/IpAddress"
          }
        },
        "macAddress" : {
          "type" : "array",
          "description" : "A map of MAC address values and their counts associated with the context results",
          "items" : {
            "$ref" : "#/definitions/MacAddress"
          }
        }
      }
    },
    "FilteredAlarmsMetaFacetCounts" : {
      "type" : "object",
      "properties" : {
        "state" : {
          "description" : "A map of state values and their counts associated with the filter results",
          "$ref" : "#/definitions/State"
        },
        "severity" : {
          "description" : "A map of severity values and their counts associated with the filter results",
          "$ref" : "#/definitions/Severity"
        },
        "serviceAffecting" : {
          "description" : "A map of service affecting values and their counts associated with the filter results",
          "$ref" : "#/definitions/ServiceAffecting"
        },
        "deviceType" : {
          "description" : "A map of device type values and their counts associated with the filter results",
          "$ref" : "#/definitions/DeviceType"
        },
        "acknowledgeState" : {
          "description" : "A map of acknowledge state values and their counts associated with the filter results",
          "$ref" : "#/definitions/AcknowledgeState"
        }
      }
    },
    "FilteredAlarmsMetaQueryAggregations" : {
      "type" : "object",
      "properties" : {
        "state" : {
          "description" : "A map of state values and their counts associated with the query results",
          "$ref" : "#/definitions/State"
        },
        "severity" : {
          "description" : "A map of severity values and their counts associated with the query results",
          "$ref" : "#/definitions/Severity"
        },
        "serviceAffecting" : {
          "description" : "A map of service affecting values and their counts associated with the query results",
          "$ref" : "#/definitions/ServiceAffecting"
        },
        "deviceType" : {
          "description" : "A map of device type values and their counts associated with the query results",
          "$ref" : "#/definitions/DeviceType"
        },
        "acknowledgeState" : {
          "description" : "A map of acknowledge state values and their counts associated with the query results",
          "$ref" : "#/definitions/AcknowledgeState"
        },
        "deviceId" : {
          "description" : "A map of device id values and their counts associated with the query results",
          "$ref" : "#/definitions/DeviceId"
        },
        "deviceName" : {
          "description" : "A map of device name values and their counts associated with the query results",
          "$ref" : "#/definitions/DeviceName"
        },
        "ipAddress" : {
          "description" : "A map of ip address values and their counts associated with the query results",
          "$ref" : "#/definitions/IpAddress"
        },
        "macAddress" : {
          "description" : "A map of mac address values and their counts associated with the query results",
          "$ref" : "#/definitions/MacAddress"
        }
      }
    },
    "Filters" : {
      "type" : "object",
      "properties" : {
        "data" : {
          "type" : "array",
          "items" : {
            "$ref" : "#/definitions/FilterData"
          }
        }
      }
    },
    "HistoricalAlarms" : {
      "type" : "object",
      "properties" : {
        "data" : {
          "type" : "array",
          "items" : {
            "$ref" : "#/definitions/HistoricalAlarmsData"
          }
        },
        "meta" : {
          "$ref" : "#/definitions/FilteredAlarmsMeta"
        },
        "links" : {
          "$ref" : "#/definitions/FilteredAlarmsLinks"
        }
      }
    },
    "HistoricalAlarmsAttributes" : {
      "type" : "object",
      "properties" : {
        "id" : {
          "type" : "string",
          "description" : "The alarm id"
        },
        "node-id" : {
          "type" : "string",
          "description" : "The unique ID associated with the node/device provided by the RA"
        },
        "node-type" : {
          "type" : "string",
          "description" : "The type of node/device, e.g. 6500"
        },
        "resource" : {
          "type" : "string",
          "description" : "The location and equipment type"
        },
        "native-condition-type" : {
          "type" : "string",
          "description" : "The native condition or alarm name"
        },
        "condition-severity" : {
          "type" : "string",
          "description" : "The severity of the alarm",
          "enum" : [ "CRITICAL", "MAJOR", "MINOR", "WARNING", "INDETERMINATE", "INFO", "CONFIG", "DEBUG" ]
        },
        "service-affecting" : {
          "type" : "string",
          "description" : "The service impact of the alarm",
          "enum" : [ "UNKNOWN", "SERVICE_AFFECTING", "NON_SERVICE_AFFECTING" ]
        },
        "additional-text" : {
          "type" : "string",
          "description" : "Additional information about the alarm"
        },
        "first-raise-time" : {
          "type" : "string",
          "format" : "date-time",
          "description" : "The date and time that the alarm was first raised"
        },
        "last-raise-time" : {
          "type" : "string",
          "format" : "date-time",
          "description" : "The date and time that the alarm was last raised"
        },
        "clear-time" : {
          "type" : "string",
          "format" : "date-time",
          "description" : "The date and time that the alarm was cleared"
        },
        "acknowledge-update-time" : {
          "type" : "string",
          "format" : "date-time",
          "description" : "The date and time that the alarms acknowledge state last changed"
        },
        "clear-user" : {
          "type" : "string",
          "description" : "The user that cleared the alarm"
        },
        "acknowledge-update-user" : {
          "type" : "string",
          "description" : "The user that last updated the acknowledge state the alarm"
        },
        "number-of-occurrences" : {
          "type" : "integer",
          "format" : "int64",
          "description" : "The number of times the alarm had occurred at the time it was cleared"
        },
        "device-name" : {
          "type" : "string",
          "description" : "Device's name."
        },
        "ip-address" : {
          "type" : "string",
          "description" : "Device's IP address."
        },
        "mac-address" : {
          "type" : "string",
          "description" : "Device's Mac address."
        },
        "device-attributes" : {
          "description" : "Device specific attributes for the alarm",
          "$ref" : "#/definitions/Device_attributes__"
        }
      }
    },
    "HistoricalAlarmsData" : {
      "type" : "object",
      "properties" : {
        "id" : {
          "type" : "string",
          "description" : "The unique identifier for the alarm"
        },
        "type" : {
          "type" : "string",
          "description" : "The Network Construct Enrollment Task resource type",
          "enum" : [ "HistoricalAlarm" ]
        },
        "attributes" : {
          "$ref" : "#/definitions/HistoricalAlarmsAttributes"
        }
      }
    },
    "IpAddress" : {
      "type" : "object"
    },
    "IpAddressesAggregation" : {
      "type" : "object",
      "properties" : {
        "data" : {
          "$ref" : "#/definitions/IpAddressesAggregationData"
        }
      }
    },
    "IpAddressesAggregationAttributes" : {
      "type" : "object",
      "properties" : {
        "ipAddresses" : {
          "type" : "array",
          "items" : {
            "$ref" : "#/definitions/IpAddress"
          }
        }
      }
    },
    "IpAddressesAggregationData" : {
      "type" : "object",
      "properties" : {
        "id" : {
          "type" : "string"
        },
        "type" : {
          "type" : "string",
          "enum" : [ "IpAddressesAggregation" ]
        },
        "attributes" : {
          "$ref" : "#/definitions/IpAddressesAggregationAttributes"
        }
      }
    },
    "LinksObject" : {
      "type" : "object"
    },
    "MacAddress" : {
      "type" : "object"
    },
    "MacAddressesAggregation" : {
      "type" : "object",
      "properties" : {
        "data" : {
          "$ref" : "#/definitions/MacAddressesAggregationData"
        }
      }
    },
    "MacAddressesAggregationAttributes" : {
      "type" : "object",
      "properties" : {
        "macAddresses" : {
          "type" : "array",
          "items" : {
            "$ref" : "#/definitions/MacAddress"
          }
        }
      }
    },
    "MacAddressesAggregationData" : {
      "type" : "object",
      "properties" : {
        "id" : {
          "type" : "string"
        },
        "type" : {
          "type" : "string",
          "enum" : [ "MacAddressesAggregation" ]
        },
        "attributes" : {
          "$ref" : "#/definitions/MacAddressesAggregationAttributes"
        }
      }
    },
    "NativeConditionType" : {
      "type" : "object",
      "properties" : {
        "value" : {
          "type" : "string"
        },
        "count" : {
          "type" : "integer",
          "format" : "int64"
        }
      }
    },
    "NativeConditionTypesAggregation" : {
      "type" : "object",
      "properties" : {
        "data" : {
          "$ref" : "#/definitions/NativeConditionTypesAggregationData"
        }
      }
    },
    "NativeConditionTypesAggregationAttributes" : {
      "type" : "object",
      "properties" : {
        "nativeConditionTypes" : {
          "type" : "array",
          "items" : {
            "$ref" : "#/definitions/NativeConditionType"
          }
        }
      }
    },
    "NativeConditionTypesAggregationData" : {
      "type" : "object",
      "properties" : {
        "id" : {
          "type" : "string"
        },
        "type" : {
          "type" : "string",
          "enum" : [ "NativeConditionTypesAggregation" ]
        },
        "attributes" : {
          "$ref" : "#/definitions/NativeConditionTypesAggregationAttributes"
        }
      }
    },
    "NodeAlarmStateRO" : {
      "type" : "object",
      "properties" : {
        "nodeId" : {
          "type" : "string"
        },
        "syncState" : {
          "type" : "string",
          "enum" : [ "DELETED", "SYNC_TRIGGERED", "SYNCHRONIZING", "SYNCHRONIZED", "SYNC_FAILED", "SYNC_PENDING", "DELETE_FAILED" ]
        },
        "lastUpdated" : {
          "type" : "string",
          "format" : "date-time"
        },
        "syncFailedReason" : {
          "type" : "string",
          "enum" : [ "RA", "TRIGGER", "SYNC", "ALARM" ]
        },
        "lastSynced" : {
          "type" : "string",
          "format" : "date-time"
        }
      }
    },
    "Resource" : {
      "type" : "object",
      "properties" : {
        "value" : {
          "type" : "string"
        },
        "count" : {
          "type" : "integer",
          "format" : "int64"
        }
      }
    },
    "ResourceObjectDeviceType" : {
      "type" : "object",
      "properties" : {
        "type" : {
          "type" : "string"
        },
        "id" : {
          "type" : "string"
        },
        "links" : {
          "type" : "object",
          "additionalProperties" : {
            "$ref" : "#/definitions/LinksObject"
          }
        },
        "attributes" : {
          "$ref" : "#/definitions/device-type"
        }
      }
    },
    "ResourcesAggregation" : {
      "type" : "object",
      "properties" : {
        "data" : {
          "$ref" : "#/definitions/ResourcesAggregationData"
        }
      }
    },
    "ResourcesAggregationAttributes" : {
      "type" : "object",
      "properties" : {
        "resources" : {
          "type" : "array",
          "items" : {
            "$ref" : "#/definitions/Resource"
          }
        }
      }
    },
    "ResourcesAggregationData" : {
      "type" : "object",
      "properties" : {
        "id" : {
          "type" : "string"
        },
        "type" : {
          "type" : "string",
          "enum" : [ "ResourcesAggregation" ]
        },
        "attributes" : {
          "$ref" : "#/definitions/ResourcesAggregationAttributes"
        }
      }
    },
    "RetentionDaysRO" : {
      "type" : "object",
      "properties" : {
        "retentionDays" : {
          "type" : "integer",
          "format" : "int32"
        }
      }
    },
    "ServiceAffecting" : {
      "type" : "object"
    },
    "Severity" : {
      "type" : "object"
    },
    "State" : {
      "type" : "object"
    },
    "SubnetName" : {
      "type" : "object",
      "properties" : {
        "value" : {
          "type" : "string"
        },
        "count" : {
          "type" : "integer",
          "format" : "int64"
        }
      }
    },
    "SubnetNamesAggregation" : {
      "type" : "object",
      "properties" : {
        "data" : {
          "$ref" : "#/definitions/SubnetNamesAggregationData"
        }
      }
    },
    "SubnetNamesAggregationAttributes" : {
      "type" : "object",
      "properties" : {
        "subnetNames" : {
          "type" : "array",
          "items" : {
            "$ref" : "#/definitions/SubnetName"
          }
        }
      }
    },
    "SubnetNamesAggregationData" : {
      "type" : "object",
      "properties" : {
        "id" : {
          "type" : "string"
        },
        "type" : {
          "type" : "string",
          "enum" : [ "SubnetNamesAggregation" ]
        },
        "attributes" : {
          "$ref" : "#/definitions/SubnetNamesAggregationAttributes"
        }
      }
    },
    "TotalAlarmRecordsCount" : {
      "type" : "object",
      "properties" : {
        "data" : {
          "$ref" : "#/definitions/TotalAlarmRecordsCountData"
        }
      }
    },
    "TotalAlarmRecordsCountAttributes" : {
      "type" : "object",
      "properties" : {
        "id" : {
          "type" : "string"
        },
        "totalRecords" : {
          "type" : "integer",
          "format" : "int64",
          "description" : "The total records count"
        }
      }
    },
    "TotalAlarmRecordsCountData" : {
      "type" : "object",
      "properties" : {
        "id" : {
          "type" : "string"
        },
        "type" : {
          "type" : "string",
          "enum" : [ "alarmRecordsCount" ]
        },
        "attributes" : {
          "$ref" : "#/definitions/TotalAlarmRecordsCountAttributes"
        }
      }
    },
    "device-type" : {
      "type" : "object",
      "required" : [ "id" ],
      "properties" : {
        "id" : {
          "type" : "string",
          "description" : "id of devicetype"
        },
        "value" : {
          "type" : "string",
          "description" : "Name of the device"
        }
      }
    }
  }
}