@itentialopensource/adapter-ciena_mcp
Version:
This adapter integrates with system described as: Ciena Mcp
1,136 lines • 7.28 MB
JSON
{
"swagger": "2.0",
"info": {
"description": "Ciena MCP API specification",
"version": "5.3.0",
"title": "Ciena MCP 5.3"
},
"schemes": [
"http",
"https"
],
"host": "localhost",
"basePath": "/",
"consumes": [
"application/json"
],
"produces": [
"application/json",
"application/yang-data+json"
],
"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/activeAlarmCountsBasic": {
"get": {
"tags": [
"Search and filter alarms (version 1)"
],
"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/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/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[annotation]",
"in": "query",
"description": "Annotation text values as a comma separated list.<p>**Example**: _ANNOTATION1,ANNOTATION2_</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 fil