{ "openapi": "3.0.1", "info": { "title": "TMF 642 Alarm Management", "description": "## TMF API Reference: TMF642 Alarm Management API", "license": { "name": "Apache 2.0", "url": "https://osl.etsi.org" }, "version": "4.0.0" }, "externalDocs": { "description": "TMF API Tables", "url": "https://www.tmforum.org/oda/open-apis/table" }, "servers": [ { "url": "https://portal.openslice.eu/tmf-api", "description": "Generated server url" } ], "security": [ { "security_auth": [] } ], "tags": [ { "name": "alarm", "description": "the alarm API" }, { "name": "clearAlarms", "description": "the clearAlarms API" }, { "name": "unGroupAlarms", "description": "the unGroupAlarms API" }, { "name": "unAckAlarms", "description": "the unAckAlarms API" }, { "name": "listener", "description": "the listener API" }, { "name": "groupAlarms", "description": "the groupAlarms API" }, { "name": "ackAlarms", "description": "the ackAlarms API" }, { "name": "hub", "description": "the hub API" }, { "name": "commentAlarms", "description": "the commentAlarms API" } ], "paths": { "/alarmManagement/v4/unGroupAlarms": { "get": { "tags": [ "unGroupAlarms" ], "summary": "List or find UnGroupAlarms objects", "description": "This operation list or find UnGroupAlarms entities", "operationId": "listUnGroupAlarms", "parameters": [ { "name": "fields", "in": "query", "description": "Comma-separated properties to be provided in response", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Requested index for start of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Requested number of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnGroupAlarms" } } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnGroupAlarms" } } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnGroupAlarms" } } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnGroupAlarms" } } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnGroupAlarms" } } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnGroupAlarms" } } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnGroupAlarms" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnGroupAlarms" } } } } } } }, "post": { "tags": [ "unGroupAlarms" ], "summary": "Creates a UnGroupAlarms", "description": "This operation creates a UnGroupAlarms entity.", "operationId": "createUnGroupAlarms", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/UnGroupAlarmsCreate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/UnGroupAlarms" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/UnGroupAlarms" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/UnGroupAlarms" } } } }, "400": { "description": "Created", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/UnGroupAlarms" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/UnGroupAlarms" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/UnGroupAlarms" } } } } } } }, "/alarmManagement/v4/unAckAlarms": { "get": { "tags": [ "unAckAlarms" ], "summary": "List or find UnAckAlarms objects", "description": "This operation list or find UnAckAlarms entities", "operationId": "listUnAckAlarms", "parameters": [ { "name": "fields", "in": "query", "description": "Comma-separated properties to be provided in response", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Requested index for start of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Requested number of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnAckAlarms" } } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnAckAlarms" } } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnAckAlarms" } } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnAckAlarms" } } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnAckAlarms" } } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnAckAlarms" } } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnAckAlarms" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnAckAlarms" } } } } } } }, "post": { "tags": [ "unAckAlarms" ], "summary": "Creates a UnAckAlarms", "description": "This operation creates a UnAckAlarms entity.", "operationId": "createUnAckAlarms", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/UnAckAlarmsCreate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/UnAckAlarms" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/UnAckAlarms" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/UnAckAlarms" } } } }, "400": { "description": "Created", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/UnAckAlarms" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/UnAckAlarms" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/UnAckAlarms" } } } } } } }, "/alarmManagement/v4/listener/unGroupAlarmsStateChangeEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity UnGroupAlarmsStateChangeEvent", "description": "Example of a client listener for receiving the notification UnGroupAlarmsStateChangeEvent", "operationId": "listenToUnGroupAlarmsStateChangeEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/UnGroupAlarmsStateChangeEvent" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/alarmManagement/v4/listener/unGroupAlarmsCreateEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity UnGroupAlarmsCreateEvent", "description": "Example of a client listener for receiving the notification UnGroupAlarmsCreateEvent", "operationId": "listenToUnGroupAlarmsCreateEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/UnGroupAlarmsCreateEvent" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/alarmManagement/v4/listener/unAckAlarmsStateChangeEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity UnAckAlarmsStateChangeEvent", "description": "Example of a client listener for receiving the notification UnAckAlarmsStateChangeEvent", "operationId": "listenToUnAckAlarmsStateChangeEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/UnAckAlarmsStateChangeEvent" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/alarmManagement/v4/listener/unAckAlarmsCreateEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity UnAckAlarmsCreateEvent", "description": "Example of a client listener for receiving the notification UnAckAlarmsCreateEvent", "operationId": "listenToUnAckAlarmsCreateEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/UnAckAlarmsCreateEvent" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/alarmManagement/v4/listener/groupAlarmsStateChangeEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity GroupAlarmsStateChangeEvent", "description": "Example of a client listener for receiving the notification GroupAlarmsStateChangeEvent", "operationId": "listenToGroupAlarmsStateChangeEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/GroupAlarmsStateChangeEvent" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/alarmManagement/v4/listener/groupAlarmsCreateEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity GroupAlarmsCreateEvent", "description": "Example of a client listener for receiving the notification GroupAlarmsCreateEvent", "operationId": "listenToGroupAlarmsCreateEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/GroupAlarmsCreateEvent" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/alarmManagement/v4/listener/commentAlarmsStateChangeEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity CommentAlarmsStateChangeEvent", "description": "Example of a client listener for receiving the notification CommentAlarmsStateChangeEvent", "operationId": "listenToCommentAlarmsStateChangeEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CommentAlarmsStateChangeEvent" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/alarmManagement/v4/listener/commentAlarmsCreateEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity CommentAlarmsCreateEvent", "description": "Example of a client listener for receiving the notification CommentAlarmsCreateEvent", "operationId": "listenToCommentAlarmsCreateEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CommentAlarmsCreateEvent" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/alarmManagement/v4/listener/clearAlarmsStateChangeEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity ClearAlarmsStateChangeEvent", "description": "Example of a client listener for receiving the notification ClearAlarmsStateChangeEvent", "operationId": "listenToClearAlarmsStateChangeEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ClearAlarmsStateChangeEvent" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/alarmManagement/v4/listener/clearAlarmsCreateEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity ClearAlarmsCreateEvent", "description": "Example of a client listener for receiving the notification ClearAlarmsCreateEvent", "operationId": "listenToClearAlarmsCreateEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ClearAlarmsCreateEvent" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/alarmManagement/v4/listener/alarmStateChangeEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity AlarmStateChangeEvent", "description": "Example of a client listener for receiving the notification AlarmStateChangeEvent", "operationId": "listenToAlarmStateChangeEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/AlarmStateChangeEvent" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/alarmManagement/v4/listener/alarmDeleteEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity AlarmDeleteEvent", "description": "Example of a client listener for receiving the notification AlarmDeleteEvent", "operationId": "listenToAlarmDeleteEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/AlarmDeleteEvent" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/alarmManagement/v4/listener/alarmCreateEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity AlarmCreateEvent", "description": "Example of a client listener for receiving the notification AlarmCreateEvent", "operationId": "listenToAlarmCreateEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/AlarmCreateEvent" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/alarmManagement/v4/listener/alarmAttributeValueChangeEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity AlarmAttributeValueChangeEvent", "description": "Example of a client listener for receiving the notification AlarmAttributeValueChangeEvent", "operationId": "listenToAlarmAttributeValueChangeEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/AlarmAttributeValueChangeEvent" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/alarmManagement/v4/listener/ackAlarmsStateChangeEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity AckAlarmsStateChangeEvent", "description": "Example of a client listener for receiving the notification AckAlarmsStateChangeEvent", "operationId": "listenToAckAlarmsStateChangeEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/AckAlarmsStateChangeEvent" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/alarmManagement/v4/listener/ackAlarmsCreateEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity AckAlarmsCreateEvent", "description": "Example of a client listener for receiving the notification AckAlarmsCreateEvent", "operationId": "listenToAckAlarmsCreateEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/AckAlarmsCreateEvent" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/alarmManagement/v4/hub": { "post": { "tags": [ "hub", "events subscription" ], "summary": "Register a listener", "description": "Sets the communication endpoint address the service instance must use to deliver information about its health state, execution state, failures and metrics.", "operationId": "registerListener642", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscriptionInput" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Subscribed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/alarmManagement/v4/groupAlarms": { "get": { "tags": [ "groupAlarms" ], "summary": "List or find GroupAlarms objects", "description": "This operation list or find GroupAlarms entities", "operationId": "listGroupAlarms", "parameters": [ { "name": "fields", "in": "query", "description": "Comma-separated properties to be provided in response", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Requested index for start of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Requested number of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupAlarms" } } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupAlarms" } } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupAlarms" } } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupAlarms" } } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupAlarms" } } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupAlarms" } } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupAlarms" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupAlarms" } } } } } } }, "post": { "tags": [ "groupAlarms" ], "summary": "Creates a GroupAlarms", "description": "This operation creates a GroupAlarms entity.", "operationId": "createGroupAlarms", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/GroupAlarmsCreate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/GroupAlarms" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/GroupAlarms" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/GroupAlarms" } } } }, "400": { "description": "Created", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/GroupAlarms" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/GroupAlarms" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/GroupAlarms" } } } } } } }, "/alarmManagement/v4/commentAlarms": { "get": { "tags": [ "commentAlarms" ], "summary": "List or find CommentAlarms objects", "description": "This operation list or find CommentAlarms entities", "operationId": "listCommentAlarms", "parameters": [ { "name": "fields", "in": "query", "description": "Comma-separated properties to be provided in response", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Requested index for start of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Requested number of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommentAlarms" } } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommentAlarms" } } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommentAlarms" } } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommentAlarms" } } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommentAlarms" } } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommentAlarms" } } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommentAlarms" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommentAlarms" } } } } } } }, "post": { "tags": [ "commentAlarms" ], "summary": "Creates a CommentAlarms", "description": "This operation creates a CommentAlarms entity.", "operationId": "createCommentAlarms", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CommentAlarmsCreate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CommentAlarms" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CommentAlarms" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CommentAlarms" } } } }, "400": { "description": "Created", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CommentAlarms" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CommentAlarms" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CommentAlarms" } } } } } } }, "/alarmManagement/v4/clearAlarms": { "get": { "tags": [ "clearAlarms" ], "summary": "List or find ClearAlarms objects", "description": "This operation list or find ClearAlarms entities", "operationId": "listClearAlarms", "parameters": [ { "name": "fields", "in": "query", "description": "Comma-separated properties to be provided in response", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Requested index for start of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Requested number of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ClearAlarms" } } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ClearAlarms" } } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ClearAlarms" } } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ClearAlarms" } } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ClearAlarms" } } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ClearAlarms" } } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ClearAlarms" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ClearAlarms" } } } } } } }, "post": { "tags": [ "clearAlarms" ], "summary": "Creates a ClearAlarms", "description": "This operation creates a ClearAlarms entity.", "operationId": "createClearAlarms", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ClearAlarmsCreate" } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ClearAlarms" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ClearAlarms" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ClearAlarms" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ClearAlarms" } } } }, "400": { "description": "Created", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ClearAlarms" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ClearAlarms" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ClearAlarms" } } } } } } }, "/alarmManagement/v4/alarm": { "get": { "tags": [ "alarm" ], "summary": "List or find Alarm objects", "description": "This operation list or find Alarm entities", "operationId": "listAlarm", "parameters": [ { "name": "fields", "in": "query", "description": "Comma-separated properties to be provided in response", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Requested index for start of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Requested number of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Alarm" } } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Alarm" } } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Alarm" } } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Alarm" } } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Alarm" } } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Alarm" } } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Alarm" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Alarm" } } } } } } }, "post": { "tags": [ "alarm" ], "summary": "Creates a Alarm", "description": "This operation creates a Alarm entity.", "operationId": "createAlarm", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/AlarmCreate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Alarm" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Alarm" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Alarm" } } } }, "400": { "description": "Created", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Alarm" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Alarm" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Alarm" } } } } } } }, "/alarmManagement/v4/ackAlarms": { "get": { "tags": [ "ackAlarms" ], "summary": "List or find AckAlarms objects", "description": "This operation list or find AckAlarms entities", "operationId": "listAckAlarms", "parameters": [ { "name": "fields", "in": "query", "description": "Comma-separated properties to be provided in response", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Requested index for start of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Requested number of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AckAlarms" } } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AckAlarms" } } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AckAlarms" } } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AckAlarms" } } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AckAlarms" } } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AckAlarms" } } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AckAlarms" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AckAlarms" } } } } } } }, "post": { "tags": [ "ackAlarms" ], "summary": "Creates a AckAlarms", "description": "This operation creates a AckAlarms entity.", "operationId": "createAckAlarms", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/AckAlarmsCreate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/AckAlarms" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/AckAlarms" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/AckAlarms" } } } }, "400": { "description": "Created", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/AckAlarms" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/AckAlarms" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/AckAlarms" } } } } } } }, "/alarmManagement/v4/alarm/{id}": { "get": { "tags": [ "alarm" ], "summary": "Retrieves a Alarm by ID", "description": "This operation retrieves a Alarm entity. Attribute selection is enabled for all first level attributes.", "operationId": "retrieveAlarm", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the Alarm", "required": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Comma-separated properties to provide in response", "required": false, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Alarm" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Alarm" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Alarm" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Alarm" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Alarm" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Alarm" } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Alarm" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Alarm" } } } } } }, "delete": { "tags": [ "alarm" ], "summary": "Deletes a Alarm", "description": "This operation deletes a Alarm entity.", "operationId": "deleteAlarm", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the Alarm", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error" }, "204": { "description": "Deleted" }, "409": { "description": "Conflict" }, "404": { "description": "Not Found" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "405": { "description": "Method Not allowed" }, "401": { "description": "Unauthorized" } } }, "patch": { "tags": [ "alarm" ], "summary": "Updates partially a Alarm", "description": "This operation updates partially a Alarm entity.", "operationId": "patchAlarm", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the Alarm", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/AlarmUpdate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Alarm" } } } }, "200": { "description": "Updated", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Alarm" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Alarm" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Alarm" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Alarm" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Alarm" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Alarm" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Alarm" } } } } } } }, "/alarmManagement/v4/unGroupAlarms/{id}": { "get": { "tags": [ "unGroupAlarms" ], "summary": "Retrieves a UnGroupAlarms by ID", "description": "This operation retrieves a UnGroupAlarms entity. Attribute selection is enabled for all first level attributes.", "operationId": "retrieveUnGroupAlarms", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the UnGroupAlarms", "required": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Comma-separated properties to provide in response", "required": false, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/UnGroupAlarms" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/UnGroupAlarms" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/UnGroupAlarms" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/UnGroupAlarms" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/UnGroupAlarms" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/UnGroupAlarms" } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/UnGroupAlarms" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/UnGroupAlarms" } } } } } } }, "/alarmManagement/v4/unAckAlarms/{id}": { "get": { "tags": [ "unAckAlarms" ], "summary": "Retrieves a UnAckAlarms by ID", "description": "This operation retrieves a UnAckAlarms entity. Attribute selection is enabled for all first level attributes.", "operationId": "retrieveUnAckAlarms", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the UnAckAlarms", "required": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Comma-separated properties to provide in response", "required": false, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/UnAckAlarms" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/UnAckAlarms" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/UnAckAlarms" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/UnAckAlarms" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/UnAckAlarms" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/UnAckAlarms" } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/UnAckAlarms" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/UnAckAlarms" } } } } } } }, "/alarmManagement/v4/groupAlarms/{id}": { "get": { "tags": [ "groupAlarms" ], "summary": "Retrieves a GroupAlarms by ID", "description": "This operation retrieves a GroupAlarms entity. Attribute selection is enabled for all first level attributes.", "operationId": "retrieveGroupAlarms", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the GroupAlarms", "required": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Comma-separated properties to provide in response", "required": false, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/GroupAlarms" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/GroupAlarms" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/GroupAlarms" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/GroupAlarms" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/GroupAlarms" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/GroupAlarms" } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/GroupAlarms" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/GroupAlarms" } } } } } } }, "/alarmManagement/v4/commentAlarms/{id}": { "get": { "tags": [ "commentAlarms" ], "summary": "Retrieves a CommentAlarms by ID", "description": "This operation retrieves a CommentAlarms entity. Attribute selection is enabled for all first level attributes.", "operationId": "retrieveCommentAlarms", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the CommentAlarms", "required": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Comma-separated properties to provide in response", "required": false, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CommentAlarms" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CommentAlarms" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CommentAlarms" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CommentAlarms" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CommentAlarms" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CommentAlarms" } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CommentAlarms" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CommentAlarms" } } } } } } }, "/alarmManagement/v4/clearAlarms/{id}": { "get": { "tags": [ "clearAlarms" ], "summary": "Retrieves a ClearAlarms by ID", "description": "This operation retrieves a ClearAlarms entity. Attribute selection is enabled for all first level attributes.", "operationId": "retrieveClearAlarms", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ClearAlarms", "required": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Comma-separated properties to provide in response", "required": false, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ClearAlarms" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ClearAlarms" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ClearAlarms" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ClearAlarms" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ClearAlarms" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ClearAlarms" } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ClearAlarms" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ClearAlarms" } } } } } } }, "/alarmManagement/v4/ackAlarms/{id}": { "get": { "tags": [ "ackAlarms" ], "summary": "Retrieves a AckAlarms by ID", "description": "This operation retrieves a AckAlarms entity. Attribute selection is enabled for all first level attributes.", "operationId": "retrieveAckAlarms", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the AckAlarms", "required": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Comma-separated properties to provide in response", "required": false, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/AckAlarms" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/AckAlarms" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/AckAlarms" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/AckAlarms" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/AckAlarms" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/AckAlarms" } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/AckAlarms" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/AckAlarms" } } } } } } }, "/alarmManagement/v4/hub/{id}": { "delete": { "tags": [ "hub", "events subscription" ], "summary": "Unregister a listener", "description": "Resets the communication endpoint address the service instance must use to deliver information about its health state, execution state, failures and metrics.", "operationId": "unregisterListener642", "parameters": [ { "name": "id", "in": "path", "description": "The id of the registered listener", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error" }, "400": { "description": "Bad request" }, "204": { "description": "Deleted" }, "405": { "description": "Method not allowed" }, "404": { "description": "Not Found" }, "403": { "description": "Forbidden" }, "401": { "description": "Unauthorized" } } } } }, "components": { "schemas": { "AffectedService": { "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "id": { "type": "string" } } }, "AlarmRef": { "type": "object", "properties": { "uuid": { "type": "string" }, "atReferredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name of the entity" }, "id": { "type": "string" }, "@referredType": { "type": "string" } } }, "AlarmRefOrValue": { "type": "object", "properties": { "uuid": { "type": "string" }, "alarmChangedTime": { "type": "string", "description": "Indicates the last date and time when the alarm is changed on the alarm-owning system. Any change to the alarm whether coming from the alarmed resource, or triggered by a change from the client is changing this time." }, "alarmClearedTime": { "type": "string", "description": "Indicates the time (as a date + time) at which the alarm is cleared at the source. " }, "alarmRaisedTime": { "type": "string", "description": "Indicates the time (as a date + time) at which the alarm occurred at its source." }, "alarmReportingTime": { "type": "string", "description": "Indicates the time (as a date + time) at which the alarm was reported by the owning OSS. It might be different from the alarmRaisedTime. For instance, if the alarm list is maintained by an EMS, the alarmRaisedtime would be the time the alarm was detected by the NE, while the alarmReportingTime would be the time this alarm was stored in the alarm list of the EMS." }, "atReferredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "A reference to the alarm." }, "name": { "type": "string", "description": "Name of the entity" }, "id": { "type": "integer", "description": "Identifier of the alarm, determined by the alarm owning system", "format": "int32" }, "ackState": { "type": "string", "description": "Provides the Acknowledgement State of the alarm" }, "ackSystemId": { "type": "string", "description": "Provides the name of the system that last changed the ackState of an alarm, i.e. acknowledged or unacknowledged the alarm." }, "ackUserId": { "type": "string", "description": "Provides the id of the user who has last changed the ack state of the alarm, i.e. acknowledged or unacknowledged the alarm." }, "alarmDetails": { "type": "string", "description": "Contains further information on the alarm." }, "alarmEscalation": { "type": "boolean", "description": "Indicates if this alarm has been escalated or not. " }, "alarmType": { "type": "string", "description": "Categorize the alarm. Should be one of the values defined in X.733 8.1.1 or 3GPP TS 32.111-2 Annex A: Communications Alarm Processing Error Alarm Environmental Alarm Quality of Service Alarm Equipment Alarm Integrity Violation Operational Violation Physical Violation Security Service or Mechanism Violation Time Domain Violation" }, "alarmedObjectType": { "type": "string", "description": "The type (class) of the managed object associated with the event." }, "clearSystemId": { "type": "string", "description": "Provides the id of the system where the user who invoked the alarmCleared operation is located. " }, "clearUserId": { "type": "string", "description": "Provides the id of the user who invoked the alarmCleared operation" }, "externalAlarmId": { "type": "string", "description": "An identifier of the alarm in the source system." }, "isRootCause": { "type": "boolean", "description": "Indicates whether the alarm is a root cause alarm.. " }, "perceivedSeverity": { "type": "string", "description": "Lists the possible severities that can be allocated to an Alarm. The values are consistent with ITU-T Recommendation X.733. Once an alarm has been cleared, its perceived severity is set to 'cleared' and can no longer be set." }, "plannedOutageIndicator": { "type": "string", "description": "Indicates that the Managed Object (related to this alarm) is in planned outage (in planned maintenance, or out-of-service). " }, "probableCause": { "type": "string", "description": "Provides the probable cause of the alarm. The values are consistent with ITU-T Recommendation X.733 or 3GPP TS 32.111-2 Annex B." }, "proposedRepairedActions": { "type": "string", "description": "Indicates proposed repair actions, if known to the system emitting the alarm." }, "reportingSystemId": { "type": "string", "description": "Reporting system identity." }, "serviceAffecting": { "type": "boolean", "description": "Indicates whether the alarm affects service or not." }, "sourceSystemId": { "type": "string", "description": "Source system identity." }, "specificProblem": { "type": "string", "description": "Provides more specific information about the alarm." }, "state": { "type": "string", "description": "Defines the alarm state during its life cycle" }, "affectedService": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/AffectedService" } }, "alarmedObject": { "$ref": "#/components/schemas/AlarmedObject" }, "comment": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Comment" } }, "correlatedAlarm": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/AlarmRef" } }, "crossedThresholdInformation": { "$ref": "#/components/schemas/CrossedThresholdInformation" }, "parentAlarm": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/AlarmRef" } }, "place": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/RelatedPlaceRefOrValue" } }, "@referredType": { "type": "string" } }, "description": "An alarm defined by reference or value. The polymorphic attributes @type, @schemaLocation & @referredType are related to the alarm entity and not the RelatedAlarmRefOrValue class itself" }, "AlarmedObject": { "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "id": { "type": "string" } }, "description": "Identifies the managed object instance associated with the alarm." }, "Comment": { "type": "object", "properties": { "uuid": { "type": "string" }, "time": { "type": "string", "description": "Indicates the time commenting the alarm" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "comment": { "type": "string", "description": "Indicates the text of the comment." }, "systemId": { "type": "string", "description": "Indicates the system identifier on which the client set the comment." }, "userId": { "type": "string", "description": "Indicates the user commenting the alarm." } }, "description": "Indicates the comments entered on the alarm." }, "CrossedThresholdInformation": { "type": "object", "properties": { "uuid": { "type": "string" }, "atType": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "direction": { "type": "string", "description": "Indicates the threshold crossing direction: up or down." }, "granularity": { "type": "string", "description": "Indicates the granularity at which the indicator is evaluated for threshold crossing" }, "indicatorName": { "type": "string", "description": "Indicates the name of indicator which crossed the threshold." }, "indicatorUnit": { "type": "string", "description": "Indicates the unit of the measurement of the indicator corresponding to the threshold that has been crossed." }, "observedValue": { "type": "string", "description": "Indicates the value of the indicator which crossed the threshold." }, "thresholdCrossingDescription": { "type": "string", "description": "Indicates further information on the threshold crossing alarm." }, "threshold": { "$ref": "#/components/schemas/ThresholdRef" } }, "description": "Identifies the details of the threshold that has been crossed." }, "RelatedPlaceRefOrValue": { "required": [ "role" ], "type": "object", "properties": { "uuid": { "type": "string" }, "atReferredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name of the entity" }, "id": { "type": "string" }, "role": { "type": "string" }, "@referredType": { "type": "string" } }, "description": "Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the place entity and not the RelatedPlaceRefOrValue class itself" }, "ThresholdRef": { "type": "object", "properties": { "uuid": { "type": "string" }, "atReferredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name of the entity" }, "id": { "type": "string" }, "@referredType": { "type": "string" } } }, "UnGroupAlarmsCreate": { "required": [ "alarmChangedTime", "correlatedAlarm", "parentAlarm", "sourceSystemId" ], "type": "object", "properties": { "atBaseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "atSchemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "atType": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "alarmChangedTime": { "type": "string", "format": "date-time" }, "sourceSystemId": { "type": "string", "description": "Source system identifier" }, "state": { "type": "string", "description": "Current state of the operation task" }, "correlatedAlarm": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "Correlated alarms", "items": { "$ref": "#/components/schemas/AlarmRefOrValue" } }, "parentAlarm": { "$ref": "#/components/schemas/AlarmRefOrValue" }, "unGroupedAlarm": { "type": "array", "description": "The successfully uncorrelated alarms", "items": { "$ref": "#/components/schemas/AlarmRefOrValue" } }, "@baseType": { "type": "string" }, "@schemaLocation": { "type": "string" }, "@type": { "type": "string" } }, "description": "The UnGroupAlarms to be created" }, "UnGroupAlarms": { "type": "object", "properties": { "uuid": { "type": "string" }, "atBaseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "atSchemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "atType": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "A reference to the task" }, "id": { "type": "string" }, "alarmChangedTime": { "type": "string", "format": "date-time" }, "sourceSystemId": { "type": "string", "description": "Source system identifier" }, "state": { "type": "string", "description": "Current state of the operation task" }, "correlatedAlarm": { "uniqueItems": true, "type": "array", "description": "Correlated alarms", "items": { "$ref": "#/components/schemas/AlarmRefOrValue" } }, "parentAlarm": { "$ref": "#/components/schemas/AlarmRefOrValue" }, "unGroupedAlarm": { "uniqueItems": true, "type": "array", "description": "The successfully uncorrelated alarms", "items": { "$ref": "#/components/schemas/AlarmRefOrValue" } } }, "description": "Task resource for ungroup alarms operation" }, "Alarm": { "type": "object", "properties": { "uuid": { "type": "string" }, "alarmChangedTime": { "type": "string", "description": "Indicates the last date and time when the alarm is changed on the alarm-owning system. Any change to the alarm whether coming from the alarmed resource, or triggered by a change from the client is changing this time." }, "alarmClearedTime": { "type": "string", "description": "Indicates the time (as a date + time) at which the alarm is cleared at the source. " }, "alarmRaisedTime": { "type": "string", "description": "Indicates the time (as a date + time) at which the alarm occurred at its source." }, "alarmReportingTime": { "type": "string", "description": "Indicates the time (as a date + time) at which the alarm was reported by the owning OSS. It might be different from the alarmRaisedTime. For instance, if the alarm list is maintained by an EMS, the alarmRaisedtime would be the time the alarm was detected by the NE, while the alarmReportingTime would be the time this alarm was stored in the alarm list of the EMS." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "A reference to the alarm." }, "id": { "type": "string" }, "ackState": { "type": "string", "description": "Provides the Acknowledgement State of the alarm" }, "ackSystemId": { "type": "string", "description": "Provides the name of the system that last changed the ackState of an alarm, i.e. acknowledged or unacknowledged the alarm." }, "ackUserId": { "type": "string", "description": "Provides the id of the user who has last changed the ack state of the alarm, i.e. acknowledged or unacknowledged the alarm." }, "alarmDetails": { "type": "string", "description": "Contains further information on the alarm." }, "alarmEscalation": { "type": "boolean", "description": "Indicates if this alarm has been escalated or not. " }, "alarmType": { "type": "string", "description": "Categorize the alarm. Should be one of the values defined in X.733 8.1.1 or 3GPP TS 32.111-2 Annex A: Communications Alarm Processing Error Alarm Environmental Alarm Quality of Service Alarm Equipment Alarm Integrity Violation Operational Violation Physical Violation Security Service or Mechanism Violation Time Domain Violation" }, "alarmedObjectType": { "type": "string", "description": "The type (class) of the managed object associated with the event." }, "clearSystemId": { "type": "string", "description": "Provides the id of the system where the user who invoked the alarmCleared operation is located. " }, "clearUserId": { "type": "string", "description": "Provides the id of the user who invoked the alarmCleared operation" }, "externalAlarmId": { "type": "string", "description": "An identifier of the alarm in the source system." }, "isRootCause": { "type": "boolean", "description": "Indicates whether the alarm is a root cause alarm.. " }, "perceivedSeverity": { "type": "string", "description": "Lists the possible severities that can be allocated to an Alarm. The values are consistent with ITU-T Recommendation X.733. Once an alarm has been cleared, its perceived severity is set to 'cleared' and can no longer be set." }, "plannedOutageIndicator": { "type": "string", "description": "Indicates that the Managed Object (related to this alarm) is in planned outage (in planned maintenance, or out-of-service). " }, "probableCause": { "type": "string", "description": "Provides the probable cause of the alarm. The values are consistent with ITU-T Recommendation X.733 or 3GPP TS 32.111-2 Annex B." }, "proposedRepairedActions": { "type": "string", "description": "Indicates proposed repair actions, if known to the system emitting the alarm." }, "reportingSystemId": { "type": "string", "description": "Reporting system identity." }, "serviceAffecting": { "type": "boolean", "description": "Indicates whether the alarm affects service or not." }, "sourceSystemId": { "type": "string", "description": "Source system identity." }, "specificProblem": { "type": "string", "description": "Provides more specific information about the alarm." }, "state": { "type": "string", "description": "Defines the alarm state during its life cycle" }, "affectedService": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/AffectedService" } }, "alarmedObject": { "$ref": "#/components/schemas/AlarmedObject" }, "comment": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Comment" } }, "correlatedAlarm": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/AlarmRef" } }, "crossedThresholdInformation": { "$ref": "#/components/schemas/CrossedThresholdInformation" }, "parentAlarm": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/AlarmRef" } }, "place": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/RelatedPlaceRefOrValue" } } }, "description": "This resource represents an alarm supporting the information model defined in ITU-T X.733." }, "UnAckAlarmsCreate": { "required": [ "ackSystemId", "ackUserId", "alarmPattern" ], "type": "object", "properties": { "atBaseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "atSchemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "atType": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "ackSystemId": { "type": "string", "description": "Name of the unacknowledging system" }, "ackTime": { "type": "string", "format": "date-time" }, "ackUserId": { "type": "string", "description": "Name of the unacknowledging user" }, "state": { "type": "string", "description": "Current state of the operation task" }, "alarmPattern": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "Alarm patterns to match target alarms. An alarm will match if all of the sttributes in any of the patterns compare equal to those attributes of the alarm.", "items": { "$ref": "#/components/schemas/Alarm" } }, "unAckedAlarm": { "type": "array", "description": "The successfully unacknowledged alarms", "items": { "$ref": "#/components/schemas/AlarmRefOrValue" } }, "@baseType": { "type": "string" }, "@schemaLocation": { "type": "string" }, "@type": { "type": "string" } }, "description": "The UnAckAlarms to be created" }, "UnAckAlarms": { "type": "object", "properties": { "uuid": { "type": "string" }, "ackTime": { "type": "string", "description": "Time of the unacknowledgement" }, "atBaseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "atSchemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "atType": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "A reference to the task" }, "id": { "type": "string" }, "ackSystemId": { "type": "string", "description": "Name of the unacknowledging system" }, "ackUserId": { "type": "string", "description": "Name of the unacknowledging user" }, "state": { "type": "string", "description": "Current state of the operation task" }, "alarmPattern": { "uniqueItems": true, "type": "array", "description": "Alarm patterns to match target alarms. An alarm will match if all of the sttributes in any of the patterns compare equal to those attributes of the alarm.", "items": { "$ref": "#/components/schemas/Alarm" } }, "unAckedAlarm": { "uniqueItems": true, "type": "array", "description": "The successfully unacknowledged alarms", "items": { "$ref": "#/components/schemas/AlarmRefOrValue" } } }, "description": "Task resource for unacknowledge alarms operation" }, "UnGroupAlarmsStateChangeEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the Process flow" }, "href": { "type": "string", "description": "Reference of the ProcessFlow" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" }, "event": { "$ref": "#/components/schemas/UnGroupAlarmsStateChangeEventPayload" } }, "description": "The event data" }, "UnGroupAlarmsStateChangeEventPayload": { "type": "object", "properties": { "unGroupAlarms": { "$ref": "#/components/schemas/UnGroupAlarms" } }, "description": "The event data structure" }, "EventSubscription": { "required": [ "callback", "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "Id of the listener" }, "callback": { "type": "string", "description": "The callback being registered." }, "query": { "type": "string", "description": "additional data to be passed" } }, "description": "Sets the communication endpoint address the service instance must use to deliver notification information" }, "UnGroupAlarmsCreateEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the Process flow" }, "href": { "type": "string", "description": "Reference of the ProcessFlow" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" }, "event": { "$ref": "#/components/schemas/UnGroupAlarmsCreateEventPayload" } }, "description": "The event data" }, "UnGroupAlarmsCreateEventPayload": { "type": "object", "properties": { "unGroupAlarms": { "$ref": "#/components/schemas/UnGroupAlarms" } }, "description": "The event data structure" }, "UnAckAlarmsStateChangeEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the Process flow" }, "href": { "type": "string", "description": "Reference of the ProcessFlow" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" }, "event": { "$ref": "#/components/schemas/UnAckAlarmsStateChangeEventPayload" } }, "description": "The event data" }, "UnAckAlarmsStateChangeEventPayload": { "type": "object", "properties": { "unAckAlarms": { "$ref": "#/components/schemas/UnAckAlarms" } }, "description": "The event data structure" }, "UnAckAlarmsCreateEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the Process flow" }, "href": { "type": "string", "description": "Reference of the ProcessFlow" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" }, "event": { "$ref": "#/components/schemas/UnAckAlarmsCreateEventPayload" } }, "description": "The event data" }, "UnAckAlarmsCreateEventPayload": { "type": "object", "properties": { "unAckAlarms": { "$ref": "#/components/schemas/UnAckAlarms" } }, "description": "The event data structure" }, "GroupAlarms": { "type": "object", "properties": { "uuid": { "type": "string" }, "alarmChangedTime": { "type": "string", "description": "Time of the correlation" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "id": { "type": "string" }, "sourceSystemId": { "type": "string", "description": "Source system identifier" }, "state": { "type": "string", "description": "Current state of the operation task" }, "correlatedAlarm": { "uniqueItems": true, "type": "array", "description": "Correlated alarms", "items": { "$ref": "#/components/schemas/AlarmRefOrValue" } }, "groupedAlarm": { "uniqueItems": true, "type": "array", "description": "The successfully correlated alarms", "items": { "$ref": "#/components/schemas/AlarmRefOrValue" } }, "parentAlarm": { "$ref": "#/components/schemas/AlarmRefOrValue" } }, "description": "Task resource for group alarms operation" }, "GroupAlarmsStateChangeEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the Process flow" }, "href": { "type": "string", "description": "Reference of the ProcessFlow" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" }, "event": { "$ref": "#/components/schemas/GroupAlarmsStateChangeEventPayload" } }, "description": "The event data" }, "GroupAlarmsStateChangeEventPayload": { "type": "object", "properties": { "groupAlarms": { "$ref": "#/components/schemas/GroupAlarms" } }, "description": "The event data structure" }, "GroupAlarmsCreateEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the Process flow" }, "href": { "type": "string", "description": "Reference of the ProcessFlow" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" }, "event": { "$ref": "#/components/schemas/GroupAlarmsCreateEventPayload" } }, "description": "The event data" }, "GroupAlarmsCreateEventPayload": { "type": "object", "properties": { "groupAlarms": { "$ref": "#/components/schemas/GroupAlarms" } }, "description": "The event data structure" }, "CommentAlarms": { "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "id": { "type": "string" }, "state": { "type": "string", "description": "Current state of the operation task" }, "alarmPattern": { "uniqueItems": true, "type": "array", "description": "Alarm patterns to match target alarms. An alarm will match if all of the sttributes in any of the patterns compare equal to those attributes of the alarm.", "items": { "$ref": "#/components/schemas/Alarm" } }, "comment": { "$ref": "#/components/schemas/Comment" }, "commentedAlarm": { "uniqueItems": true, "type": "array", "description": "The successfully commented alarms", "items": { "$ref": "#/components/schemas/AlarmRefOrValue" } } }, "description": "Task resource for comment alarms operation" }, "CommentAlarmsStateChangeEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the Process flow" }, "href": { "type": "string", "description": "Reference of the ProcessFlow" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" }, "event": { "$ref": "#/components/schemas/CommentAlarmsStateChangeEventPayload" } }, "description": "The event data" }, "CommentAlarmsStateChangeEventPayload": { "type": "object", "properties": { "commentAlarms": { "$ref": "#/components/schemas/CommentAlarms" } }, "description": "The event data structure" }, "CommentAlarmsCreateEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the Process flow" }, "href": { "type": "string", "description": "Reference of the ProcessFlow" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" }, "event": { "$ref": "#/components/schemas/CommentAlarmsCreateEventPayload" } }, "description": "The event data" }, "CommentAlarmsCreateEventPayload": { "type": "object", "properties": { "commentAlarms": { "$ref": "#/components/schemas/CommentAlarms" } }, "description": "The event data structure" }, "ClearAlarms": { "type": "object", "properties": { "uuid": { "type": "string" }, "alarmClearedTime": { "type": "string", "description": "Time of the alarm clearing" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "id": { "type": "string" }, "clearSystemId": { "type": "string", "description": "Name of the clearing system" }, "clearUserId": { "type": "string", "description": "Name of the clearing user" }, "state": { "type": "string", "description": "Current state of the operation task" }, "alarmPattern": { "uniqueItems": true, "type": "array", "description": "Alarm patterns to match target alarms. An alarm will match if all of the sttributes in any of the patterns compare equal to those attributes of the alarm.", "items": { "$ref": "#/components/schemas/Alarm" } }, "clearedAlarm": { "uniqueItems": true, "type": "array", "description": "The successfully cleared alarms", "items": { "$ref": "#/components/schemas/AlarmRefOrValue" } } }, "description": "Task resource for clear alarms operation" }, "ClearAlarmsStateChangeEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the Process flow" }, "href": { "type": "string", "description": "Reference of the ProcessFlow" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" }, "event": { "$ref": "#/components/schemas/ClearAlarmsStateChangeEventPayload" } }, "description": "The event data" }, "ClearAlarmsStateChangeEventPayload": { "type": "object", "properties": { "clearAlarms": { "$ref": "#/components/schemas/ClearAlarms" } }, "description": "The event data structure" }, "ClearAlarmsCreateEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the Process flow" }, "href": { "type": "string", "description": "Reference of the ProcessFlow" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" }, "event": { "$ref": "#/components/schemas/ClearAlarmsCreateEventPayload" } }, "description": "The event data" }, "ClearAlarmsCreateEventPayload": { "type": "object", "properties": { "clearAlarms": { "$ref": "#/components/schemas/ClearAlarms" } }, "description": "The event data structure" }, "AlarmStateChangeEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the Process flow" }, "href": { "type": "string", "description": "Reference of the ProcessFlow" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" }, "event": { "$ref": "#/components/schemas/AlarmStateChangeEventPayload" } }, "description": "The event data" }, "AlarmStateChangeEventPayload": { "type": "object", "properties": { "alarm": { "$ref": "#/components/schemas/Alarm" } }, "description": "The event data structure" }, "AlarmDeleteEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the Process flow" }, "href": { "type": "string", "description": "Reference of the ProcessFlow" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" }, "event": { "$ref": "#/components/schemas/AlarmDeleteEventPayload" } }, "description": "The event data" }, "AlarmDeleteEventPayload": { "type": "object", "properties": { "alarm": { "$ref": "#/components/schemas/Alarm" } }, "description": "The event data structure" }, "AlarmCreateEvent": { "type": "object", "properties": { "eventTime": { "type": "string", "description": "Time of the event occurrence." }, "timeOcurred": { "type": "string", "description": "The time the event occured." }, "id": { "type": "string", "description": "Identifier of the Process flow" }, "href": { "type": "string", "description": "Reference of the ProcessFlow" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "event": { "$ref": "#/components/schemas/AlarmCreateEventPayload" } }, "description": "The event data" }, "AlarmCreateEventPayload": { "type": "object", "properties": { "alarm": { "$ref": "#/components/schemas/Alarm" } }, "description": "The event data structure" }, "AlarmAttributeValueChangeEvent": { "type": "object", "properties": { "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" }, "fieldPath": { "type": "string", "description": "The path identifying the object field concerned by this notification." }, "event": { "$ref": "#/components/schemas/AlarmAttributeValueChangeEventPayload" } }, "description": "The event data" }, "AlarmAttributeValueChangeEventPayload": { "type": "object", "properties": { "alarm": { "$ref": "#/components/schemas/Alarm" } }, "description": "The event data structure" }, "AckAlarms": { "type": "object", "properties": { "uuid": { "type": "string" }, "ackTime": { "type": "string", "description": "Time of the acknowledgement" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "id": { "type": "string" }, "ackSystemId": { "type": "string", "description": "Name of the acknowledging system" }, "ackUserId": { "type": "string", "description": "Name of the acknowledging user" }, "state": { "type": "string", "description": "Current state of the operation task" }, "ackedAlarm": { "uniqueItems": true, "type": "array", "description": "The successfully acknowledged alarms", "items": { "$ref": "#/components/schemas/AlarmRefOrValue" } }, "alarmPattern": { "uniqueItems": true, "type": "array", "description": "Alarm patterns to match target alarms. An alarm will match if all of the sttributes in any of the patterns compare equal to those attributes of the alarm.", "items": { "$ref": "#/components/schemas/Alarm" } } }, "description": "Task resource for the acknowledge alarms operation" }, "AckAlarmsStateChangeEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the Process flow" }, "href": { "type": "string", "description": "Reference of the ProcessFlow" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" }, "event": { "$ref": "#/components/schemas/AckAlarmsStateChangeEventPayload" } }, "description": "The event data" }, "AckAlarmsStateChangeEventPayload": { "type": "object", "properties": { "ackAlarms": { "$ref": "#/components/schemas/AckAlarms" } }, "description": "The event data structure" }, "AckAlarmsCreateEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the Process flow" }, "href": { "type": "string", "description": "Reference of the ProcessFlow" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" }, "event": { "$ref": "#/components/schemas/AckAlarmsCreateEventPayload" } }, "description": "The event data" }, "AckAlarmsCreateEventPayload": { "type": "object", "properties": { "ackAlarms": { "$ref": "#/components/schemas/AckAlarms" } }, "description": "The event data structure" }, "EventSubscriptionInput": { "required": [ "callback" ], "type": "object", "properties": { "callback": { "type": "string", "description": "The callback being registered." }, "query": { "type": "string", "description": "additional data to be passed" } }, "description": "Data containing the callback endpoint to deliver the information" }, "GroupAlarmsCreate": { "required": [ "alarmChangedTime", "correlatedAlarm", "parentAlarm", "sourceSystemId" ], "type": "object", "properties": { "atBaseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "atSchemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "atType": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "alarmChangedTime": { "type": "string", "format": "date-time" }, "sourceSystemId": { "type": "string", "description": "Source system identifier" }, "state": { "type": "string", "description": "Current state of the operation task" }, "correlatedAlarm": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "Correlated alarms", "items": { "$ref": "#/components/schemas/AlarmRefOrValue" } }, "groupedAlarm": { "type": "array", "description": "The successfully correlated alarms", "items": { "$ref": "#/components/schemas/AlarmRefOrValue" } }, "parentAlarm": { "$ref": "#/components/schemas/AlarmRefOrValue" }, "@baseType": { "type": "string" }, "@schemaLocation": { "type": "string" }, "@type": { "type": "string" } }, "description": "The GroupAlarms to be created" }, "CommentAlarmsCreate": { "required": [ "alarmPattern", "comment" ], "type": "object", "properties": { "atBaseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "atSchemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "atType": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "state": { "type": "string", "description": "Current state of the operation task" }, "alarmPattern": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "Alarm patterns to match target alarms. An alarm will match if all of the sttributes in any of the patterns compare equal to those attributes of the alarm.", "items": { "$ref": "#/components/schemas/Alarm" } }, "comment": { "$ref": "#/components/schemas/Comment" }, "commentedAlarm": { "type": "array", "description": "The successfully commented alarms", "items": { "$ref": "#/components/schemas/AlarmRefOrValue" } }, "@baseType": { "type": "string" }, "@schemaLocation": { "type": "string" }, "@type": { "type": "string" } }, "description": "The CommentAlarms to be created" }, "ClearAlarmsCreate": { "required": [ "alarmClearedTime", "alarmPattern", "clearSystemId", "clearUserId" ], "type": "object", "properties": { "atBaseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "atSchemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "atType": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "alarmClearedTime": { "type": "string", "format": "date-time" }, "clearSystemId": { "type": "string", "description": "Name of the clearing system" }, "clearUserId": { "type": "string", "description": "Name of the clearing user" }, "state": { "type": "string", "description": "Current state of the operation task" }, "alarmPattern": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "Alarm patterns to match target alarms. An alarm will match if all of the sttributes in any of the patterns compare equal to those attributes of the alarm.", "items": { "$ref": "#/components/schemas/Alarm" } }, "clearedAlarm": { "type": "array", "description": "The successfully cleared alarms", "items": { "$ref": "#/components/schemas/AlarmRefOrValue" } }, "@baseType": { "type": "string" }, "@schemaLocation": { "type": "string" }, "@type": { "type": "string" } }, "description": "The ClearAlarms to be created" }, "AlarmCreate": { "required": [ "alarmRaisedTime", "sourceSystemId" ], "type": "object", "properties": { "alarmChangedTime": { "type": "string", "description": "Indicates the last date and time when the alarm is changed on the alarm-owning system. Any change to the alarm whether coming from the alarmed resource, or triggered by a change from the client is changing this time." }, "alarmClearedTime": { "type": "string", "description": "Indicates the time (as a date + time) at which the alarm is cleared at the source. " }, "alarmReportingTime": { "type": "string", "description": "Indicates the time (as a date + time) at which the alarm was reported by the owning OSS. It might be different from the alarmRaisedTime. For instance, if the alarm list is maintained by an EMS, the alarmRaisedtime would be the time the alarm was detected by the NE, while the alarmReportingTime would be the time this alarm was stored in the alarm list of the EMS." }, "alarmRaisedTime": { "type": "string", "description": "Indicates the time (as a date + time) at which the alarm occurred at its source." }, "atBaseType": { "type": "string", "description": "The base type of this alarm." }, "atSchemaLocation": { "type": "string", "description": "A reference to the schema describing this alarm." }, "atType": { "type": "string", "description": "The type for this alarm." }, "ackState": { "type": "string", "description": "Provides the Acknowledgement State of the alarm" }, "ackSystemId": { "type": "string", "description": "Provides the name of the system that last changed the ackState of an alarm, i.e. acknowledged or unacknowledged the alarm." }, "ackUserId": { "type": "string", "description": "Provides the id of the user who has last changed the ack state of the alarm, i.e. acknowledged or unacknowledged the alarm." }, "alarmDetails": { "type": "string", "description": "Contains further information on the alarm." }, "alarmEscalation": { "type": "boolean", "description": "Indicates if this alarm has been escalated or not. " }, "alarmType": { "type": "string", "description": "Categorize the alarm. Should be one of the values defined in X.733 8.1.1 or 3GPP TS 32.111-2 Annex A: Communications Alarm Processing Error Alarm Environmental Alarm Quality of Service Alarm Equipment Alarm Integrity Violation Operational Violation Physical Violation Security Service or Mechanism Violation Time Domain Violation" }, "alarmedObjectType": { "type": "string", "description": "The type (class) of the managed object associated with the event." }, "clearSystemId": { "type": "string", "description": "Provides the id of the system where the user who invoked the alarmCleared operation is located. " }, "clearUserId": { "type": "string", "description": "Provides the id of the user who invoked the alarmCleared operation" }, "externalAlarmId": { "type": "string", "description": "An identifier of the alarm in the source system." }, "isRootCause": { "type": "boolean", "description": "Indicates whether the alarm is a root cause alarm.. " }, "perceivedSeverity": { "type": "string", "description": "Lists the possible severities that can be allocated to an Alarm. The values are consistent with ITU-T Recommendation X.733. Once an alarm has been cleared, its perceived severity is set to 'cleared' and can no longer be set." }, "plannedOutageIndicator": { "type": "string", "description": "Indicates that the Managed Object (related to this alarm) is in planned outage (in planned maintenance, or out-of-service). " }, "probableCause": { "type": "string", "description": "Provides the probable cause of the alarm. The values are consistent with ITU-T Recommendation X.733 or 3GPP TS 32.111-2 Annex B." }, "proposedRepairedActions": { "type": "string", "description": "Indicates proposed repair actions, if known to the system emitting the alarm." }, "reportingSystemId": { "type": "string", "description": "Reporting system identity." }, "serviceAffecting": { "type": "boolean", "description": "Indicates whether the alarm affects service or not." }, "specificProblem": { "type": "string", "description": "Provides more specific information about the alarm." }, "state": { "type": "string", "description": "Defines the alarm state during its life cycle" }, "affectedService": { "type": "array", "items": { "$ref": "#/components/schemas/AffectedService" } }, "alarmedObject": { "$ref": "#/components/schemas/AlarmedObject" }, "comment": { "type": "array", "items": { "$ref": "#/components/schemas/Comment" } }, "correlatedAlarm": { "type": "array", "items": { "$ref": "#/components/schemas/AlarmRef" } }, "crossedThresholdInformation": { "$ref": "#/components/schemas/CrossedThresholdInformation" }, "parentAlarm": { "type": "array", "items": { "$ref": "#/components/schemas/AlarmRef" } }, "place": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedPlaceRefOrValue" } }, "@baseType": { "type": "string" }, "@schemaLocation": { "type": "string" }, "@type": { "type": "string" }, "sourceSystemId": { "type": "string", "description": "Source system identity." } }, "description": "The Alarm to be created" }, "AckAlarmsCreate": { "required": [ "ackSystemId", "ackUserId", "alarmPattern" ], "type": "object", "properties": { "atBaseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "atSchemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "atType": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "ackSystemId": { "type": "string", "description": "Name of the acknowledging system" }, "ackTime": { "type": "string", "format": "date-time" }, "ackUserId": { "type": "string", "description": "Name of the acknowledging user" }, "state": { "type": "string", "description": "Current state of the operation task" }, "ackedAlarm": { "type": "array", "description": "The successfully acknowledged alarms", "items": { "$ref": "#/components/schemas/AlarmRefOrValue" } }, "alarmPattern": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "Alarm patterns to match target alarms. An alarm will match if all of the sttributes in any of the patterns compare equal to those attributes of the alarm.", "items": { "$ref": "#/components/schemas/Alarm" } }, "@baseType": { "type": "string" }, "@schemaLocation": { "type": "string" }, "@type": { "type": "string" } }, "description": "The AckAlarms to be created" }, "AlarmUpdate": { "type": "object", "properties": { "alarmChangedTime": { "type": "string", "description": "Indicates the last date and time when the alarm is changed on the alarm-owning system. Any change to the alarm whether coming from the alarmed resource, or triggered by a change from the client is changing this time." }, "alarmClearedTime": { "type": "string", "description": "Indicates the time (as a date + time) at which the alarm is cleared at the source. " }, "alarmReportingTime": { "type": "string", "description": "Indicates the time (as a date + time) at which the alarm was reported by the owning OSS. It might be different from the alarmRaisedTime. For instance, if the alarm list is maintained by an EMS, the alarmRaisedtime would be the time the alarm was detected by the NE, while the alarmReportingTime would be the time this alarm was stored in the alarm list of the EMS." }, "atBaseType": { "type": "string", "description": "The base type of this alarm." }, "atSchemaLocation": { "type": "string", "description": "A reference to the schema describing this alarm." }, "atType": { "type": "string", "description": "The type for this alarm." }, "ackState": { "type": "string", "description": "Provides the Acknowledgement State of the alarm" }, "ackSystemId": { "type": "string", "description": "Provides the name of the system that last changed the ackState of an alarm, i.e. acknowledged or unacknowledged the alarm." }, "ackUserId": { "type": "string", "description": "Provides the id of the user who has last changed the ack state of the alarm, i.e. acknowledged or unacknowledged the alarm." }, "alarmDetails": { "type": "string", "description": "Contains further information on the alarm." }, "alarmEscalation": { "type": "boolean", "description": "Indicates if this alarm has been escalated or not. " }, "alarmType": { "type": "string", "description": "Categorize the alarm. Should be one of the values defined in X.733 8.1.1 or 3GPP TS 32.111-2 Annex A: Communications Alarm Processing Error Alarm Environmental Alarm Quality of Service Alarm Equipment Alarm Integrity Violation Operational Violation Physical Violation Security Service or Mechanism Violation Time Domain Violation" }, "alarmedObjectType": { "type": "string", "description": "The type (class) of the managed object associated with the event." }, "clearSystemId": { "type": "string", "description": "Provides the id of the system where the user who invoked the alarmCleared operation is located. " }, "clearUserId": { "type": "string", "description": "Provides the id of the user who invoked the alarmCleared operation" }, "externalAlarmId": { "type": "string", "description": "An identifier of the alarm in the source system." }, "isRootCause": { "type": "boolean", "description": "Indicates whether the alarm is a root cause alarm.. " }, "perceivedSeverity": { "type": "string", "description": "Lists the possible severities that can be allocated to an Alarm. The values are consistent with ITU-T Recommendation X.733. Once an alarm has been cleared, its perceived severity is set to 'cleared' and can no longer be set." }, "plannedOutageIndicator": { "type": "string", "description": "Indicates that the Managed Object (related to this alarm) is in planned outage (in planned maintenance, or out-of-service). " }, "probableCause": { "type": "string", "description": "Provides the probable cause of the alarm. The values are consistent with ITU-T Recommendation X.733 or 3GPP TS 32.111-2 Annex B." }, "proposedRepairedActions": { "type": "string", "description": "Indicates proposed repair actions, if known to the system emitting the alarm." }, "reportingSystemId": { "type": "string", "description": "Reporting system identity." }, "serviceAffecting": { "type": "boolean", "description": "Indicates whether the alarm affects service or not." }, "specificProblem": { "type": "string", "description": "Provides more specific information about the alarm." }, "state": { "type": "string", "description": "Defines the alarm state during its life cycle" }, "affectedService": { "type": "array", "items": { "$ref": "#/components/schemas/AffectedService" } }, "alarmedObject": { "$ref": "#/components/schemas/AlarmedObject" }, "comment": { "type": "array", "items": { "$ref": "#/components/schemas/Comment" } }, "correlatedAlarm": { "type": "array", "items": { "$ref": "#/components/schemas/AlarmRef" } }, "crossedThresholdInformation": { "$ref": "#/components/schemas/CrossedThresholdInformation" }, "parentAlarm": { "type": "array", "items": { "$ref": "#/components/schemas/AlarmRef" } }, "place": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedPlaceRefOrValue" } }, "@baseType": { "type": "string" }, "@schemaLocation": { "type": "string" }, "@type": { "type": "string" } }, "description": "The Alarm to be updated" } }, "securitySchemes": { "security_auth": { "type": "oauth2", "scheme": "bearer", "bearerFormat": "JWT", "flows": { "authorizationCode": { "authorizationUrl": "https://portal.openslice.eu/auth/realms/openslice/protocol/openid-connect/auth", "tokenUrl": "https://portal.openslice.eu/auth/realms/openslice/protocol/openid-connect/token", "scopes": { "read": "read scope", "write": "write scope" } } } } } } }