@itentialopensource/adapter-nokia_nsp_network

{ "openapi": "3.0.0", "info": { "title": "Network Supervision REST APIs", "description": "The Network Supervision application allows users to monitor the health of objects, such as NEs, card slots, cards, ports, links or link aggregation groups, using KPIs, and monitor the fault status of a network. The objects returned are coming from all deployed source systems. Access InformationPrior to accessing the API services below, the API client must authenticate the NSP user via the NSP REST Gateway's authentication API service. The api-docs for the REST Gateway can be found with the NSP Product at: https://<server>/rest-gateway/api-docs/ - where <server> is the hostname or IP address of the installed NSP serveror via the NSP DevPortal at: <a href='https://nsp.developer.nokia.com/api-documentation/'>https://nsp.developer.nokia.com/api-documentation/</a> - you will need to create an account on the NSP DevPortal to gain access to the api-docs", "contact": {}, "version": "1.0" }, "servers": [ { "url": "https://147.75.202.66:8544/NetworkSupervision/rest/api", "variables": {} } ], "paths": { "/v1/cardSlots": { "get": { "tags": [ "cardSlots" ], "summary": "getCardSlotsUsingGET", "description": "Returns a paged list of specific card slots. The size of each page is determined by the 'limit' query parameter. The list will contain the FDN of each resulting card slot. Each card slot contains a link to the installed card, if not empty. Not providing a filter will return all card slots. Filterable properties: sourceType: The type of the source system. For example: nfmp sourceSystem: The partial FDN identifying the source system. For example: fdn:realm:sam name: The user friendly visible name neName: The name of the Network Element containing the Card Slot neId: The id of the Network Element containing the Card Slot description: The detailed description of the Card Slot positionId: The relative position of the Card Slot that determines the order in which to show it in the source system UI position: A formatted name that describes the position of the Card Slot within the Network Element adminState: The administrative state operState: The operational state standbyState: The standby state availabilityStates: The availability state stateReasons: A set of specific reasons why the Card Slot is in this state objectDetails: Generic properties of the Card Slot manufacturer: The vendor of the Card Slot serialNumber: The serial number of the Card Slot provided by the manufacturer partNumber: The part number of the Card Slot provided by the manufacturer manufacturerAssemblyNumber: The assembly number of the Card Slot provided by the manufacturer manufactureDate: The date of manufacture of the Card Slot manufacturingDeviations: The manufacturing deviations of the Card Slot provided by the manufacturer macAddress: The base MAC Address of the Card Slot hwMacAddress: The Hardware MAC Address of the Card Slot provisionedType: The type of Card provisioned in the Card Slot actualType: The type of Card present in the Card Slot holderState: The status of the Card Slot Examples: Get all card slots: GET /v1/cardSlots Get all card slots, using a comma-separated list of FDNs: GET /v1/cardSlots?fdns=fdn:model:equipment:EquipmentHolder:2127,fdn:model:equipment:EquipmentHolder:2128 Get all card slots, with filter by holderState: GET /v1/cardSlots?filter=holderState%3D'installedAndExpected' Get all card slots, with filter by provisionedType: GET /v1/cardSlots?filter=NOT%20(provisionedType%20LIKE%20'%25IOM%25') Get all card slots, with filter by combined criteria: GET /v1/cardSlots?filter=holderState%3D'installedAndExpected'%20AND%20NOT%20(provisionedType%20LIKE%20'%25IOM%25')", "operationId": "getCardSlotsUsingGET", "parameters": [ { "name": "fdns", "in": "query", "description": "A comma-separated list of the Fully Distinguished Names of the NSP objects to query for.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "The limit on the number of objects returned (max: 1000)", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "default": 300 } }, { "name": "offset", "in": "query", "description": "Start row for paged data (max: total number of objects)", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CardSlot" }, "description": "" } } } }, "400": { "description": "Bad Request - Malformed content or invalid parameter data provided", "headers": {}, "content": {} }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": {} }, "404": { "description": "Not Found - URL or resource does not exist", "headers": {}, "content": {} }, "405": { "description": "Method Not Allowed - HTTP method not allowed for this endpoint", "headers": {}, "content": {} }, "500": { "description": "Internal Server Error - Server error", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v1/cardSlots/{cardSlotFdn}": { "get": { "tags": [ "cardSlots" ], "summary": "getCardSlotUsingGET", "description": "Returns detailed information for the specified card slot, which contains a link to the installed card, if not empty. Example: GET /v1/cardSlots/fdn:model:equipment:EquipmentHolder:2127", "operationId": "getCardSlotUsingGET", "parameters": [ { "name": "cardSlotFdn", "in": "path", "description": "cardSlotFdn", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardSlot" } } } }, "400": { "description": "Bad Request - Malformed content or invalid parameter data provided", "headers": {}, "content": {} }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": {} }, "403": { "description": "Forbidden - No user access to the resource", "headers": {}, "content": {} }, "404": { "description": "Not Found - URL or resource does not exist", "headers": {}, "content": {} }, "405": { "description": "Method Not Allowed - HTTP method not allowed for this endpoint", "headers": {}, "content": {} }, "422": { "description": "Unprocessable Entity - Invalid FDN provided", "headers": {}, "content": {} }, "500": { "description": "Internal Server Error - Server error", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v1/cards": { "get": { "tags": [ "cards" ], "summary": "getCardsUsingGET", "description": "Returns a paged list of specific cards. The size of each page is determined by the 'limit' query parameter. The list will contain the FDN of each resulting card. Not providing a filter will return all cards. Filterable properties: sourceType: The type of the source system. For example: nfmp sourceSystem: The partial FDN identifying the source system. For example: fdn:realm:sam name: The user friendly visible name neName: The name of the Network Element containing the Card neId: The id of the Network Element containing the Card description: The detailed description of the Card positionId: The relative position of the Card that determines the order in which to show it in the source system UI position: A formatted name that describes the position of the Card within the Network Element adminState: The administrative state operState: The operational state standbyState: The standby state availabilityStates: The availability state stateReasons: A set of specific reasons why the Card is in this state objectDetails: Generic properties of the Card manufacturer: The vendor of the Card serialNumber: The serial number of the Card provided by the manufacturer partNumber: The part number of the Card provided by the manufacturer manufacturerAssemblyNumber: The assembly number of the Card provided by the manufacturer manufactureDate: The date of manufacture of the Card manufacturingDeviations: The manufacturing deviations of the Card provided by the manufacturer macAddress: The base MAC Address of the Card hwMacAddress: The Hardware MAC Address of the Card Examples: Get all cards: GET /v1/cards Get all cards, using a comma-separated list of FDNs: GET /v1/cards?fdns=fdn:model:equipment:Equipment:2184,fdn:model:equipment:Equipment:2186 Get all cards, with filter by manufacturerAssemblyNumber: GET /v1/cards?filter=manufacturerAssemblyNumber%20LIKE%20'%252345%25' Get all cards, with filter by partNumber: GET /v1/cards?filter=partNumber%3D'c18e522906354010bb21e4b78b2ca014' Get all cards, with filter by combined criteria: GET /v1/cards?filter=manufacturerAssemblyNumber%20LIKE%20'%252345%25'%20AND%20partNumber%3D'c18e522906354010bb21e4b78b2ca014'", "operationId": "getCardsUsingGET", "parameters": [ { "name": "fdns", "in": "query", "description": "A comma-separated list of the Fully Distinguished Names of the NSP objects to query for.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "The limit on the number of objects returned (max: 1000)", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "default": 300 } }, { "name": "offset", "in": "query", "description": "Start row for paged data (max: total number of objects)", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Card" }, "description": "" } } } }, "400": { "description": "Bad Request - Malformed content or invalid parameter data provided", "headers": {}, "content": {} }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": {} }, "404": { "description": "Not Found - URL or resource does not exist", "headers": {}, "content": {} }, "405": { "description": "Method Not Allowed - HTTP method not allowed for this endpoint", "headers": {}, "content": {} }, "500": { "description": "Internal Server Error - Server error", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v1/cards/{cardFdn}": { "get": { "tags": [ "cards" ], "summary": "getCardUsingGET", "description": "Returns detailed information for the specified card. Example: GET /v1/cards/fdn:model:equipment:Equipment:2184", "operationId": "getCardUsingGET", "parameters": [ { "name": "cardFdn", "in": "path", "description": "cardFdn", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Card" } } } }, "400": { "description": "Bad Request - Malformed content or invalid parameter data provided", "headers": {}, "content": {} }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": {} }, "403": { "description": "Forbidden - No user access to the resource", "headers": {}, "content": {} }, "404": { "description": "Not Found - URL or resource does not exist", "headers": {}, "content": {} }, "405": { "description": "Method Not Allowed - HTTP method not allowed for this endpoint", "headers": {}, "content": {} }, "422": { "description": "Unprocessable Entity - Invalid FDN provided", "headers": {}, "content": {} }, "500": { "description": "Internal Server Error - Server error", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v1/lags": { "get": { "tags": [ "lags" ], "summary": "getLAGsUsingGET", "description": "Returns a paged list of specific LAGs. The size of each page is determined by the 'limit' query parameter. The list will contain the FDN of each resulting LAG. Not providing a filter will return all LAGs. Filterable properties: sourceType: The type of the source system. For example: nfmp sourceSystem: The partial FDN identifying the source system. For example: fdn:realm:sam name: The user friendly visible name neName: The name of this LAG neId: The id of this LAG description: The detailed description of this LAG configuredAddress: The MAC Address of this LAG encapType: The encapsulation type of this LAG operationalSpeedUnits: The units associated to the ‘operationalSpeed’ field value for this LAG operationalSpeed: The total operational speed of this LAG, in units specified by the ‘operationalSpeedUnits’ field value adminState: The administrative state operState: The operational state standbyState: The standby state availabilityStates: The availability state stateReasons: A set of specific reasons why the LAG is in this state objectDetails: Generic properties of this LAG Examples: Get all LAGs: GET /v1/lags Get all LAGs, using a comma-separated list of FDNs: GET /v1/lags?fdns=fdn:model:equipment:LAG:12872,fdn:model:equipment:LAG:12873 Get all LAGs, with filter by configuredAddress: GET /v1/lags?filter=configuredAddress%20LIKE%20'C0-3E%25' Get all LAGs, with filter by neId: GET /v1/lags?filter=neId%20LIKE%20'%25.85' Get all LAGs, with filter by combined criteria: GET /v1/lags?filter=NOT%20(configuredAddress%20LIKE%20'C0-3E%25')%20AND%20neId%20LIKE%20'%25.85'", "operationId": "getLAGsUsingGET", "parameters": [ { "name": "fdns", "in": "query", "description": "A comma-separated list of the Fully Distinguished Names of the NSP objects to query for.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "The limit on the number of objects returned (max: 1000)", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "default": 300 } }, { "name": "offset", "in": "query", "description": "Start row for paged data (max: total number of objects)", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LAG" }, "description": "" } } } }, "400": { "description": "Bad Request - Malformed content or invalid parameter data provided", "headers": {}, "content": {} }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": {} }, "404": { "description": "Not Found - URL or resource does not exist", "headers": {}, "content": {} }, "405": { "description": "Method Not Allowed - HTTP method not allowed for this endpoint", "headers": {}, "content": {} }, "500": { "description": "Internal Server Error - Server error", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v1/lags/{lagFdn}": { "get": { "tags": [ "lags" ], "summary": "getLAGUsingGET", "description": "Returns detailed information for the specified LAG. Example: GET /v1/lags/fdn:model:equipment:LAG:12872", "operationId": "getLAGUsingGET", "parameters": [ { "name": "lagFdn", "in": "path", "description": "lagFdn", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LAG" } } } }, "400": { "description": "Bad Request - Malformed content or invalid parameter data provided", "headers": {}, "content": {} }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": {} }, "403": { "description": "Forbidden - No user access to the resource", "headers": {}, "content": {} }, "404": { "description": "Not Found - URL or resource does not exist", "headers": {}, "content": {} }, "405": { "description": "Method Not Allowed - HTTP method not allowed for this endpoint", "headers": {}, "content": {} }, "422": { "description": "Unprocessable Entity - Invalid FDN provided", "headers": {}, "content": {} }, "500": { "description": "Internal Server Error - Server error", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v1/networkElements": { "get": { "tags": [ "networkElements" ], "summary": "getNEsUsingGET", "description": "Returns a paged list of specific network elements. The size of each page is determined by the 'limit' query parameter. The list will contain the FDN of each resulting network element. Not providing a filter will return all network elements. Filterable properties: sourceType: The type of the source system. For example: nfmp sourceSystem: The partial FDN identifying the source system. For example: fdn:realm:sam name: The name of this Network Element, as defined by the source system neName: The name of the Network Element which is unique within the source system neId: The id of the Network Element description: The detailed description of the Network Element ipAddress: The management IP address of the Network Element type: The type of the Network Element product: The vendor product name of the Network Element version: The version of the Network Element resyncState: The resynchronization status of the Network Element longitude: The longitude (in degrees) of the Network Element, if known. Min = -180, Max = 180 latitude: The latitude (in degrees) of the Network Element, if known. Min = -90, Max = 90 location: The location of the Network Element topologyGroup: The Fully Distinguished Name of the topology group that the Network Element belongs to, if any adminState: The administrative state operState: The operational state standbyState: The standby state availabilityStates: The availability state objectDetails: Generic properties of the Network Element networkType: The type of network the Network Element is part of communicationState: The communication status of the Network Element communicationStateDetails: The reachability status of each supported management protocol of the Network Element macAddress: The Mac address of the Network Element clliCode: Common Language Location Identifier (CLLI) code value for the system Examples: Get all network elements: GET /v1/networkElements Get all network elements, using a comma-separated list of FDNs: GET /v1/networkElements?fdns=fdn:model:equipment:NetworkElement:2102,fdn:model:equipment:NetworkElement:2103 Get all network elements, with filter by managedState: GET /v1/networkElements?filter=managedState%3D'managed' Get all network elements, with filter by product: GET /v1/networkElements?filter=product%20LIKE%20'7750%25' Get all network elements, with filter by combined criteria: GET /v1/networkElements?filter=managedState%3D'managed'%20AND%20NOT%20(product%20LIKE%20'7750%25')", "operationId": "getNEsUsingGET", "parameters": [ { "name": "fdns", "in": "query", "description": "A comma-separated list of the Fully Distinguished Names of the NSP objects to query for.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "The limit on the number of objects returned (max: 1000)", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "default": 300 } }, { "name": "offset", "in": "query", "description": "Start row for paged data (max: total number of objects)", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkElement" }, "description": "" } } } }, "400": { "description": "Bad Request - Malformed content or invalid parameter data provided", "headers": {}, "content": {} }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": {} }, "404": { "description": "Not Found - URL or resource does not exist", "headers": {}, "content": {} }, "405": { "description": "Method Not Allowed - HTTP method not allowed for this endpoint", "headers": {}, "content": {} }, "500": { "description": "Internal Server Error - Server error", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v1/networkElements/{networkElementFdn}": { "get": { "tags": [ "networkElements" ], "summary": "getNEUsingGET", "description": "Returns detailed information for the specified network element. Example: GET /v1/networkElements/fdn:model:equipment:NetworkElement:2102", "operationId": "getNEUsingGET", "parameters": [ { "name": "networkElementFdn", "in": "path", "description": "networkElementFdn", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkElement" } } } }, "400": { "description": "Bad Request - Malformed content or invalid parameter data provided", "headers": {}, "content": {} }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": {} }, "403": { "description": "Forbidden - No user access to the resource", "headers": {}, "content": {} }, "404": { "description": "Not Found - URL or resource does not exist", "headers": {}, "content": {} }, "405": { "description": "Method Not Allowed - HTTP method not allowed for this endpoint", "headers": {}, "content": {} }, "422": { "description": "Unprocessable Entity - Invalid FDN provided", "headers": {}, "content": {} }, "500": { "description": "Internal Server Error - Server error", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v1/networkElements/{networkElementFdn}/lags": { "get": { "tags": [ "networkElements" ], "summary": "getNELAGsUsingGET", "description": "Returns a list of specific LAGs. The list will contain the FDN of each resulting LAG. Not providing a filter will return all LAGs. Filterable properties: sourceType: The type of the source system. For example: nfmp sourceSystem: The partial FDN identifying the source system. For example: fdn:realm:sam name: The name of the LAG, as defined by the source system neName: The name of the LAG which is unique within the source system neId: The id of the LAG description: The detailed description of the LAG configuredAddress: The MAC Address of the LAG encapType: The encapsulation type of the LAG operationalSpeedUnits: The units associated to the ‘operationalSpeed’ field value for the LAG operationalSpeed: The total operational speed of the LAG, in units specified by the ‘operationalSpeedUnits’ field value adminState: The administrative state operState: The operational state standbyState: The standby state availabilityStates: The availability state objectDetails: Generic properties of the LAG Examples: ", "operationId": "getNELAGsUsingGET", "parameters": [ { "name": "filter", "in": "query", "description": "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "networkElementFdn", "in": "path", "description": "networkElementFdn", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LAG" }, "description": "" } } } }, "400": { "description": "Bad Request - Malformed content or invalid parameter data provided", "headers": {}, "content": {} }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": {} }, "403": { "description": "Forbidden - No user access to the resource", "headers": {}, "content": {} }, "404": { "description": "Not Found - URL or resource does not exist", "headers": {}, "content": {} }, "405": { "description": "Method Not Allowed - HTTP method not allowed for this endpoint", "headers": {}, "content": {} }, "422": { "description": "Unprocessable Entity - Invalid FDN provided", "headers": {}, "content": {} }, "500": { "description": "Internal Server Error - Server error", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v1/networkElements/{networkElementFdn}/lags/{lagFdn}/lagMembers": { "get": { "tags": [ "networkElements" ], "summary": "getLagMembersUsingGET", "description": "Returns a list of specific LAG members. The list will contain the FDN of each resulting LAG member. Not providing a filter will return all LAG members. Examples: ", "operationId": "getLagMembersUsingGET", "parameters": [ { "name": "filter", "in": "query", "description": "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "lagFdn", "in": "path", "description": "lagFdn", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "networkElementFdn", "in": "path", "description": "networkElementFdn", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LAGMemberDetails" }, "description": "" } } } }, "400": { "description": "Bad Request - Malformed content or invalid parameter data provided", "headers": {}, "content": {} }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": {} }, "403": { "description": "Forbidden - No user access to the resource", "headers": {}, "content": {} }, "404": { "description": "Not Found - URL or resource does not exist", "headers": {}, "content": {} }, "405": { "description": "Method Not Allowed - HTTP method not allowed for this endpoint", "headers": {}, "content": {} }, "422": { "description": "Unprocessable Entity - Invalid FDN provided", "headers": {}, "content": {} }, "500": { "description": "Internal Server Error - Server error", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v1/networkElements/{networkElementFdn}/radioEquipment": { "get": { "tags": [ "networkElements" ], "summary": "getNERadioEquipmentsUsingGET", "description": "Returns a list of specific radio equipments. The list will contain the FDN of each resulting Radio Equipment. Not providing a filter will return all Radio Equipments. Filterable properties: sourceType: The type of the source system. For example: nfmp sourceSystem: The partial FDN identifying the source system. For example: fdn:realm:sam name: The name of the radio equipment, as defined by the source system neName: The name of the radio equipment which is unique within the source system neId: The id of the radio equipment description: The detailed description of the radio equipment ipAddress: The management IP address of the radio equipment product: The vendor product name of the radio equipment version: The version of this radio equipment longitude: The longitude (in degrees) of the radio equipment, if known. Min = -180, Max = 180 latitude: The latitude (in degrees) of the radio equipment, if known. Min = -90, Max = 90 location: The location of the radio equipment adminState: The administrative state operState: The operational state standbyState: The standby state communicationState: The communication status of the radio equipment availabilityStates: The availability state objectDetails: Generic properties of the radio equipment macAddress: The Mac address of the radio equipment clliCode: Common Language Location Identifier (CLLI) code value for the system Examples: ", "operationId": "getNERadioEquipmentsUsingGET", "parameters": [ { "name": "filter", "in": "query", "description": "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "networkElementFdn", "in": "path", "description": "networkElementFdn", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RadioEquipment" }, "description": "" } } } }, "400": { "description": "Bad Request - Malformed content or invalid parameter data provided", "headers": {}, "content": {} }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": {} }, "403": { "description": "Forbidden - No user access to the resource", "headers": {}, "content": {} }, "404": { "description": "Not Found - URL or resource does not exist", "headers": {}, "content": {} }, "405": { "description": "Method Not Allowed - HTTP method not allowed for this endpoint", "headers": {}, "content": {} }, "422": { "description": "Unprocessable Entity - Invalid FDN provided", "headers": {}, "content": {} }, "500": { "description": "Internal Server Error - Server error", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v1/networkElements/{networkElementFdn}/radioEquipment/{radioEquipmentFdn}/lags": { "get": { "tags": [ "networkElements" ], "summary": "getRadioEquipmentLagsUsingGET", "description": "Returns a list of specific LAGs on a radio equipment linked to a network element. The list will contain the FDN of each resulting LAG. Not providing a filter will return all LAGs. Filterable properties: sourceType: The type of the source system. For example: nfmp sourceSystem: The partial FDN identifying the source system. For example: fdn:realm:sam name: The user friendly visible name neName: The name of the LAG neId: The id of the LAG description: The detailed description of the LAG configuredAddress: The MAC Address of the LAG encapType: The encapsulation type of the LAG operationalSpeedUnits: The units associated to the ‘operationalSpeed’ field value for the LAG operationalSpeed: The total operational speed of the LAG, in units specified by the ‘operationalSpeedUnits’ field value adminState: The administrative state operState: The operational state standbyState: The standby state availabilityStates: The availability state stateReasons: A set of specific reasons why the LAG is in this state objectDetails: Generic properties of the LAG Examples: ", "operationId": "getRadioEquipmentLagsUsingGET", "parameters": [ { "name": "filter", "in": "query", "description": "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "networkElementFdn", "in": "path", "description": "networkElementFdn", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "radioEquipmentFdn", "in": "path", "description": "radioEquipmentFdn", "required": tru