{ "openapi": "3.1.0", "info": { "title": "", "version": "1.0.0" }, "paths": { "/v1/cardSlots": { "get": { "tags": [ "CardSlots" ], "operationId": "getCardSlotsUsingGET", "description": "The parameters and request body are for method: getCardSlotsUsingGET. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "type": "string" }, "templated": { "type": "boolean" } } } }, "fdn": { "type": "string" }, "sourceType": { "type": "object" }, "sourceSystem": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "neName": { "type": "string" }, "neId": { "type": "string" }, "description": { "type": "string" }, "positionId": { "type": "number" }, "position": { "type": "string" }, "adminState": { "type": "object" }, "operState": { "type": "object" }, "standbyState": { "type": "object" }, "availabilityStates": { "type": "array", "items": { "type": "string" } }, "stateReasons": { "type": "array", "items": { "type": "string" } }, "objectDetails": { "type": "object" }, "manufacturer": { "type": "string" }, "serialNumber": { "type": "string" }, "partNumber": { "type": "string" }, "manufacturerAssemblyNumber": { "type": "string" }, "manufactureDate": { "type": "string" }, "manufacturingDeviations": { "type": "string" }, "macAddress": { "type": "string" }, "hwMacAddress": { "type": "string" }, "provisionedType": { "type": "string" }, "actualType": { "type": "string" }, "holderState": { "type": "string" } } } }, "example": [ { "links": [ { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true } ], "fdn": "string", "sourceType": null, "sourceSystem": "string", "sources": [ "string", "string", "string", "string", "string" ], "name": "string", "neName": "string", "neId": "string", "description": "string", "positionId": 2, "position": "string", "adminState": null, "operState": null, "standbyState": null, "availabilityStates": [ "unknown", "notInstalled" ], "stateReasons": [ "string", "string" ], "objectDetails": {}, "manufacturer": "string", "serialNumber": "string", "partNumber": "string", "manufacturerAssemblyNumber": "string", "manufactureDate": "string", "manufacturingDeviations": "string", "macAddress": "string", "hwMacAddress": "string", "provisionedType": "string", "actualType": "string", "holderState": "string" }, { "links": [ { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true } ], "fdn": "string", "sourceType": null, "sourceSystem": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string" ], "name": "string", "neName": "string", "neId": "string", "description": "string", "positionId": 9, "position": "string", "adminState": null, "operState": null, "standbyState": null, "availabilityStates": [ "offLine", "unknown" ], "stateReasons": [ "string", "string", "string", "string", "string", "string", "string" ], "objectDetails": {}, "manufacturer": "string", "serialNumber": "string", "partNumber": "string", "manufacturerAssemblyNumber": "string", "manufactureDate": "string", "manufacturingDeviations": "string", "macAddress": "string", "hwMacAddress": "string", "provisionedType": "string", "actualType": "string", "holderState": "string" }, { "links": [ { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false } ], "fdn": "string", "sourceType": null, "sourceSystem": "string", "sources": [ "string", "string", "string", "string", "string" ], "name": "string", "neName": "string", "neId": "string", "description": "string", "positionId": 10, "position": "string", "adminState": null, "operState": null, "standbyState": null, "availabilityStates": [ "inTest", "offLine", "offDuty", "degraded", "failed", "powerOff" ], "stateReasons": [ "string", "string", "string", "string", "string", "string" ], "objectDetails": {}, "manufacturer": "string", "serialNumber": "string", "partNumber": "string", "manufacturerAssemblyNumber": "string", "manufactureDate": "string", "manufacturingDeviations": "string", "macAddress": "string", "hwMacAddress": "string", "provisionedType": "string", "actualType": "string", "holderState": "string" } ] } } } }, "parameters": [ { "name": "fdns", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/cardSlots/{cardSlotFdn}": { "get": { "tags": [ "CardSlots" ], "operationId": "getCardSlotUsingGET", "description": "The parameters and request body are for method: getCardSlotUsingGET. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "cardSlotFdn", "in": "path", "required": true, "schema": { "title": "cardSlotFdn", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/cards": { "get": { "tags": [ "Cards" ], "operationId": "getCardsUsingGET", "description": "The parameters and request body are for method: getCardsUsingGET. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "type": "string" }, "templated": { "type": "boolean" } } } }, "fdn": { "type": "string" }, "sourceType": { "type": "object" }, "sourceSystem": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "neName": { "type": "string" }, "neId": { "type": "string" }, "description": { "type": "string" }, "positionId": { "type": "number" }, "position": { "type": "string" }, "adminState": { "type": "object" }, "operState": { "type": "object" }, "standbyState": { "type": "object" }, "availabilityStates": { "type": "array", "items": { "type": "string" } }, "stateReasons": { "type": "array", "items": { "type": "string" } }, "objectDetails": { "type": "object" }, "manufacturer": { "type": "string" }, "serialNumber": { "type": "string" }, "partNumber": { "type": "string" }, "manufacturerAssemblyNumber": { "type": "string" }, "manufactureDate": { "type": "string" }, "manufacturingDeviations": { "type": "string" }, "macAddress": { "type": "string" }, "hwMacAddress": { "type": "string" }, "cardDetails": { "type": "object", "properties": { "fdn": { "type": "string" }, "sourceType": { "type": "object" }, "sourceSystem": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "objectDetails": { "type": "object" }, "cardType": { "type": "string" }, "equippedPorts": { "type": "number" }, "capabilities": { "type": "array", "items": { "type": "string" } }, "availableSlots": { "type": "number" }, "installedSlots": { "type": "number" }, "memorySize": { "type": "number" }, "lastBootUpReason": { "type": "string" } } } } } }, "example": [ { "links": [ { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false } ], "fdn": "string", "sourceType": null, "sourceSystem": "string", "sources": [ "string" ], "name": "string", "neName": "string", "neId": "string", "description": "string", "positionId": 7, "position": "string", "adminState": null, "operState": null, "standbyState": null, "availabilityStates": [ "notInstalled" ], "stateReasons": [ "string", "string", "string", "string", "string" ], "objectDetails": {}, "manufacturer": "string", "serialNumber": "string", "partNumber": "string", "manufacturerAssemblyNumber": "string", "manufactureDate": "string", "manufacturingDeviations": "string", "macAddress": "string", "hwMacAddress": "string", "cardDetails": { "fdn": "fdn:model:equipment:CardDetails:2203", "sourceType": null, "sourceSystem": "fdn:realm:sam", "sources": [ "fdn:realm:sam:network:38.120.169.111:shelf-1:cardSlot-2:card@cardDetails" ], "objectDetails": {}, "cardType": "500g CPM / Switch Fabric 3", "equippedPorts": 40, "capabilities": [ "string", "string", "string", "string", "string", "string" ], "availableSlots": 2, "installedSlots": 1, "memorySize": 16392, "lastBootUpReason": "Hard Reboot" } } ] } } } }, "parameters": [ { "name": "fdns", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/cards/{cardFdn}": { "get": { "tags": [ "Cards" ], "operationId": "getCardUsingGET", "description": "The parameters and request body are for method: getCardUsingGET. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "cardFdn", "in": "path", "required": true, "schema": { "title": "cardFdn", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/lags": { "get": { "tags": [ "Lags" ], "operationId": "getLAGsUsingGET", "description": "The parameters and request body are for method: getLAGsUsingGET. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "type": "string" }, "templated": { "type": "boolean" } } } }, "fdn": { "type": "string" }, "sourceType": { "type": "object" }, "sourceSystem": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "lagId": { "type": "string" }, "neName": { "type": "string" }, "neId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "configuredAddress": { "type": "string" }, "encapType": { "type": "object" }, "operationalSpeedUnits": { "type": "string" }, "operationalSpeed": { "type": "number" }, "lagMode": { "type": "object" }, "adminState": { "type": "object" }, "operState": { "type": "object" }, "standbyState": { "type": "object" }, "availabilityStates": { "type": "array", "items": { "type": "string" } }, "stateReasons": { "type": "array", "items": { "type": "string" } }, "objectDetails": { "type": "object" }, "members": { "type": "array", "items": { "type": "object", "properties": { "encapType": { "type": "string" }, "fdn": { "type": "string" }, "lagId": { "type": "string" }, "objectDetails": { "type": "object" }, "portFdn": { "type": "string" }, "portName": { "type": "string" }, "priority": { "type": "number" }, "sourceSystem": { "type": "string" }, "sourceType": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "standbyState": { "type": "string" } } } }, "multiChassisLAGMembers": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "fdn": { "type": "string" }, "lacpKey": { "type": "number" }, "objectDetails": { "type": "object" }, "peerIpAddress": { "type": "string" }, "peerNeId": { "type": "string" }, "remoteLagId": { "type": "string" }, "sourceSystem": { "type": "string" }, "sourceType": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "standbyState": { "type": "string" }, "systemId": { "type": "string" }, "systemPriority": { "type": "number" } } } }, "parentNe": { "type": "string" }, "parent": { "type": "string" } } } }, "example": [ { "links": [ { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false } ], "fdn": "string", "sourceType": null, "sourceSystem": "string", "sources": [ "string", "string", "string", "string" ], "lagId": "string", "neName": "string", "neId": "string", "name": "string", "description": "string", "configuredAddress": "string", "encapType": null, "operationalSpeedUnits": "string", "operationalSpeed": 5, "lagMode": null, "adminState": null, "operState": null, "standbyState": null, "availabilityStates": [ "failed", "inTest", "degraded", "notInstalled", "logFull", "dependency", "offLine", "unknown" ], "stateReasons": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "objectDetails": {}, "members": [ { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 1, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 4, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 10, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 5, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 8, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 5, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 9, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 4, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 3, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 4, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string" ], "standbyState": "string" } ], "multiChassisLAGMembers": [ { "description": "string", "fdn": "string", "lacpKey": 9, "objectDetails": {}, "peerIpAddress": "string", "peerNeId": "string", "remoteLagId": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string" ], "standbyState": "string", "systemId": "string", "systemPriority": 2 }, { "description": "string", "fdn": "string", "lacpKey": 2, "objectDetails": {}, "peerIpAddress": "string", "peerNeId": "string", "remoteLagId": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string", "systemId": "string", "systemPriority": 4 }, { "description": "string", "fdn": "string", "lacpKey": 1, "objectDetails": {}, "peerIpAddress": "string", "peerNeId": "string", "remoteLagId": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string", "systemId": "string", "systemPriority": 9 }, { "description": "string", "fdn": "string", "lacpKey": 3, "objectDetails": {}, "peerIpAddress": "string", "peerNeId": "string", "remoteLagId": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string" ], "standbyState": "string", "systemId": "string", "systemPriority": 10 }, { "description": "string", "fdn": "string", "lacpKey": 1, "objectDetails": {}, "peerIpAddress": "string", "peerNeId": "string", "remoteLagId": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string", "systemId": "string", "systemPriority": 4 }, { "description": "string", "fdn": "string", "lacpKey": 10, "objectDetails": {}, "peerIpAddress": "string", "peerNeId": "string", "remoteLagId": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string", "systemId": "string", "systemPriority": 5 } ], "parentNe": "string", "parent": "string" }, { "links": [ { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false } ], "fdn": "string", "sourceType": null, "sourceSystem": "string", "sources": [ "string", "string", "string", "string", "string" ], "lagId": "string", "neName": "string", "neId": "string", "name": "string", "description": "string", "configuredAddress": "string", "encapType": null, "operationalSpeedUnits": "string", "operationalSpeed": 6, "lagMode": null, "adminState": null, "operState": null, "standbyState": null, "availabilityStates": [ "offDuty", "offLine", "dependency", "degraded", "unknown", "failed", "notInstalled", "offDuty", "degraded" ], "stateReasons": [ "string", "string", "string", "string", "string", "string", "string" ], "objectDetails": {}, "members": [ { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 7, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 5, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 3, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 8, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 9, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 6, "sourceSystem": "string", "sourceType": "string", "sources": [ "string" ], "standbyState": "string" } ], "multiChassisLAGMembers": [ { "description": "string", "fdn": "string", "lacpKey": 3, "objectDetails": {}, "peerIpAddress": "string", "peerNeId": "string", "remoteLagId": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string" ], "standbyState": "string", "systemId": "string", "systemPriority": 3 }, { "description": "string", "fdn": "string", "lacpKey": 3, "objectDetails": {}, "peerIpAddress": "string", "peerNeId": "string", "remoteLagId": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string" ], "standbyState": "string", "systemId": "string", "systemPriority": 7 }, { "description": "string", "fdn": "string", "lacpKey": 10, "objectDetails": {}, "peerIpAddress": "string", "peerNeId": "string", "remoteLagId": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string" ], "standbyState": "string", "systemId": "string", "systemPriority": 6 }, { "description": "string", "fdn": "string", "lacpKey": 7, "objectDetails": {}, "peerIpAddress": "string", "peerNeId": "string", "remoteLagId": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string" ], "standbyState": "string", "systemId": "string", "systemPriority": 8 }, { "description": "string", "fdn": "string", "lacpKey": 1, "objectDetails": {}, "peerIpAddress": "string", "peerNeId": "string", "remoteLagId": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string", "systemId": "string", "systemPriority": 3 }, { "description": "string", "fdn": "string", "lacpKey": 7, "objectDetails": {}, "peerIpAddress": "string", "peerNeId": "string", "remoteLagId": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string", "systemId": "string", "systemPriority": 10 } ], "parentNe": "string", "parent": "string" }, { "links": [ { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true } ], "fdn": "string", "sourceType": null, "sourceSystem": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "lagId": "string", "neName": "string", "neId": "string", "name": "string", "description": "string", "configuredAddress": "string", "encapType": null, "operationalSpeedUnits": "string", "operationalSpeed": 1, "lagMode": null, "adminState": null, "operState": null, "standbyState": null, "availabilityStates": [ "logFull", "logFull", "degraded", "unknown", "notInstalled" ], "stateReasons": [ "string" ], "objectDetails": {}, "members": [ { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 5, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 10, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 10, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 6, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 9, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 5, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 8, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 4, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 1, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string" } ], "multiChassisLAGMembers": [ { "description": "string", "fdn": "string", "lacpKey": 3, "objectDetails": {}, "peerIpAddress": "string", "peerNeId": "string", "remoteLagId": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string" ], "standbyState": "string", "systemId": "string", "systemPriority": 4 }, { "description": "string", "fdn": "string", "lacpKey": 4, "objectDetails": {}, "peerIpAddress": "string", "peerNeId": "string", "remoteLagId": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string" ], "standbyState": "string", "systemId": "string", "systemPriority": 7 } ], "parentNe": "string", "parent": "string" } ] } } } }, "parameters": [ { "name": "fdns", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/lags/{lagFdn}": { "get": { "tags": [ "Lags" ], "operationId": "getLAGUsingGET", "description": "The parameters and request body are for method: getLAGUsingGET. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "lagFdn", "in": "path", "required": true, "schema": { "title": "lagFdn", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/networkElements": { "get": { "tags": [ "NetworkElements" ], "operationId": "getNEsUsingGET", "description": "The parameters and request body are for method: getNEsUsingGET. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "type": "string" }, "templated": { "type": "boolean" } } } }, "fdn": { "type": "string" }, "sourceType": { "type": "object" }, "sourceSystem": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "neName": { "type": "string" }, "neId": { "type": "string" }, "description": { "type": "string" }, "ipAddress": { "type": "string" }, "type": { "type": "string" }, "product": { "type": "string" }, "version": { "type": "string" }, "resyncState": { "type": "object" }, "managedState": { "type": "object" }, "longitude": { "type": "number" }, "latitude": { "type": "number" }, "location": { "type": "string" }, "topologyGroup": { "type": "string" }, "adminState": { "type": "object" }, "operState": { "type": "object" }, "standbyState": { "type": "object" }, "availabilityStates": { "type": "array", "items": { "type": "string" } }, "objectDetails": { "type": "object" }, "networkType": { "type": "object" }, "communicationState": { "type": "object" }, "communicationStateDetails": { "type": "object" }, "macAddress": { "type": "string" }, "clliCode": { "type": "string" } } } }, "example": [ { "links": [ { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true } ], "fdn": "string", "sourceType": null, "sourceSystem": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string" ], "name": "string", "neName": "string", "neId": "string", "description": "string", "ipAddress": "string", "type": "string", "product": "string", "version": "string", "resyncState": null, "managedState": null, "longitude": 7, "latitude": 6, "location": "string", "topologyGroup": "string", "adminState": null, "operState": null, "standbyState": null, "availabilityStates": [ "unknown", "notInstalled", "degraded", "notInstalled", "powerOff" ], "objectDetails": {}, "networkType": null, "communicationState": null, "communicationStateDetails": {}, "macAddress": "string", "clliCode": "string" }, { "links": [ { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false } ], "fdn": "string", "sourceType": null, "sourceSystem": "string", "sources": [ "string", "string", "string", "string" ], "name": "string", "neName": "string", "neId": "string", "description": "string", "ipAddress": "string", "type": "string", "product": "string", "version": "string", "resyncState": null, "managedState": null, "longitude": 1, "latitude": 4, "location": "string", "topologyGroup": "string", "adminState": null, "operState": null, "standbyState": null, "availabilityStates": [ "dependency", "offDuty", "powerOff", "offLine", "logFull", "logFull", "dependency", "offLine", "logFull", "notInstalled" ], "objectDetails": {}, "networkType": null, "communicationState": null, "communicationStateDetails": {}, "macAddress": "string", "clliCode": "string" } ] } } } }, "parameters": [ { "name": "fdns", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/networkElements/{networkElementFdn}": { "get": { "tags": [ "NetworkElements" ], "operationId": "getNEUsingGET", "description": "The parameters and request body are for method: getNEUsingGET. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "networkElementFdn", "in": "path", "required": true, "schema": { "title": "networkElementFdn", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/networkElements/{networkElementFdn}/lags": { "get": { "tags": [ "NetworkElements" ], "operationId": "getNELAGsUsingGET", "description": "The parameters and request body are for method: getNELAGsUsingGET. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "type": "string" }, "templated": { "type": "boolean" } } } }, "fdn": { "type": "string" }, "sourceType": { "type": "object" }, "sourceSystem": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "lagId": { "type": "string" }, "neName": { "type": "string" }, "neId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "configuredAddress": { "type": "string" }, "encapType": { "type": "object" }, "operationalSpeedUnits": { "type": "string" }, "operationalSpeed": { "type": "number" }, "lagMode": { "type": "object" }, "adminState": { "type": "object" }, "operState": { "type": "object" }, "standbyState": { "type": "object" }, "availabilityStates": { "type": "array", "items": { "type": "string" } }, "stateReasons": { "type": "array", "items": { "type": "string" } }, "objectDetails": { "type": "object" }, "members": { "type": "array", "items": { "type": "object", "properties": { "encapType": { "type": "string" }, "fdn": { "type": "string" }, "lagId": { "type": "string" }, "objectDetails": { "type": "object" }, "portFdn": { "type": "string" }, "portName": { "type": "string" }, "priority": { "type": "number" }, "sourceSystem": { "type": "string" }, "sourceType": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "standbyState": { "type": "string" } } } }, "multiChassisLAGMembers": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "fdn": { "type": "string" }, "lacpKey": { "type": "number" }, "objectDetails": { "type": "object" }, "peerIpAddress": { "type": "string" }, "peerNeId": { "type": "string" }, "remoteLagId": { "type": "string" }, "sourceSystem": { "type": "string" }, "sourceType": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "standbyState": { "type": "string" }, "systemId": { "type": "string" }, "systemPriority": { "type": "number" } } } }, "parentNe": { "type": "string" }, "parent": { "type": "string" } } } }, "example": [ { "links": [ { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false } ], "fdn": "string", "sourceType": null, "sourceSystem": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string" ], "lagId": "string", "neName": "string", "neId": "string", "name": "string", "description": "string", "configuredAddress": "string", "encapType": null, "operationalSpeedUnits": "string", "operationalSpeed": 3, "lagMode": null, "adminState": null, "operState": null, "standbyState": null, "availabilityStates": [ "dependency", "inTest", "notInstalled", "offDuty", "degraded", "notInstalled", "notInstalled", "offLine", "unknown", "degraded" ], "stateReasons": [ "string", "string" ], "objectDetails": {}, "members": [ { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 1, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 9, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 1, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 3, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 4, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 7, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 5, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string" } ], "multiChassisLAGMembers": [ { "description": "string", "fdn": "string", "lacpKey": 6, "objectDetails": {}, "peerIpAddress": "string", "peerNeId": "string", "remoteLagId": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string", "systemId": "string", "systemPriority": 3 }, { "description": "string", "fdn": "string", "lacpKey": 3, "objectDetails": {}, "peerIpAddress": "string", "peerNeId": "string", "remoteLagId": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string" ], "standbyState": "string", "systemId": "string", "systemPriority": 7 }, { "description": "string", "fdn": "string", "lacpKey": 1, "objectDetails": {}, "peerIpAddress": "string", "peerNeId": "string", "remoteLagId": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string" ], "standbyState": "string", "systemId": "string", "systemPriority": 9 }, { "description": "string", "fdn": "string", "lacpKey": 2, "objectDetails": {}, "peerIpAddress": "string", "peerNeId": "string", "remoteLagId": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string", "systemId": "string", "systemPriority": 6 }, { "description": "string", "fdn": "string", "lacpKey": 8, "objectDetails": {}, "peerIpAddress": "string", "peerNeId": "string", "remoteLagId": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string", "systemId": "string", "systemPriority": 2 }, { "description": "string", "fdn": "string", "lacpKey": 4, "objectDetails": {}, "peerIpAddress": "string", "peerNeId": "string", "remoteLagId": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string", "systemId": "string", "systemPriority": 7 } ], "parentNe": "string", "parent": "string" }, { "links": [ { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false } ], "fdn": "string", "sourceType": null, "sourceSystem": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string" ], "lagId": "string", "neName": "string", "neId": "string", "name": "string", "description": "string", "configuredAddress": "string", "encapType": null, "operationalSpeedUnits": "string", "operationalSpeed": 4, "lagMode": null, "adminState": null, "operState": null, "standbyState": null, "availabilityStates": [ "unknown", "logFull", "dependency", "degraded", "notInstalled", "degraded", "offLine", "dependency", "unknown" ], "stateReasons": [ "string", "string", "string", "string", "string" ], "objectDetails": {}, "members": [ { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 6, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 7, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 7, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 9, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 2, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 10, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 8, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 7, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 3, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 3, "sourceSystem": "string", "sourceType": "string", "sources": [ "string" ], "standbyState": "string" } ], "multiChassisLAGMembers": [ { "description": "string", "fdn": "string", "lacpKey": 8, "objectDetails": {}, "peerIpAddress": "string", "peerNeId": "string", "remoteLagId": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string" ], "standbyState": "string", "systemId": "string", "systemPriority": 9 }, { "description": "string", "fdn": "string", "lacpKey": 3, "objectDetails": {}, "peerIpAddress": "string", "peerNeId": "string", "remoteLagId": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string", "systemId": "string", "systemPriority": 1 }, { "description": "string", "fdn": "string", "lacpKey": 10, "objectDetails": {}, "peerIpAddress": "string", "peerNeId": "string", "remoteLagId": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string" ], "standbyState": "string", "systemId": "string", "systemPriority": 9 }, { "description": "string", "fdn": "string", "lacpKey": 6, "objectDetails": {}, "peerIpAddress": "string", "peerNeId": "string", "remoteLagId": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string" ], "standbyState": "string", "systemId": "string", "systemPriority": 8 } ], "parentNe": "string", "parent": "string" }, { "links": [ { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false } ], "fdn": "string", "sourceType": null, "sourceSystem": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string" ], "lagId": "string", "neName": "string", "neId": "string", "name": "string", "description": "string", "configuredAddress": "string", "encapType": null, "operationalSpeedUnits": "string", "operationalSpeed": 6, "lagMode": null, "adminState": null, "operState": null, "standbyState": null, "availabilityStates": [ "notInstalled", "degraded", "offDuty", "unknown", "failed" ], "stateReasons": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "objectDetails": {}, "members": [ { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 5, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 10, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 10, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 9, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 4, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 2, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 9, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 4, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 3, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string" ], "standbyState": "string" } ], "multiChassisLAGMembers": [ { "description": "string", "fdn": "string", "lacpKey": 8, "objectDetails": {}, "peerIpAddress": "string", "peerNeId": "string", "remoteLagId": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string" ], "standbyState": "string", "systemId": "string", "systemPriority": 6 }, { "description": "string", "fdn": "string", "lacpKey": 4, "objectDetails": {}, "peerIpAddress": "string", "peerNeId": "string", "remoteLagId": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string" ], "standbyState": "string", "systemId": "string", "systemPriority": 4 }, { "description": "string", "fdn": "string", "lacpKey": 9, "objectDetails": {}, "peerIpAddress": "string", "peerNeId": "string", "remoteLagId": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string" ], "standbyState": "string", "systemId": "string", "systemPriority": 7 }, { "description": "string", "fdn": "string", "lacpKey": 3, "objectDetails": {}, "peerIpAddress": "string", "peerNeId": "string", "remoteLagId": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string", "systemId": "string", "systemPriority": 1 }, { "description": "string", "fdn": "string", "lacpKey": 2, "objectDetails": {}, "peerIpAddress": "string", "peerNeId": "string", "remoteLagId": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string", "systemId": "string", "systemPriority": 2 }, { "description": "string", "fdn": "string", "lacpKey": 4, "objectDetails": {}, "peerIpAddress": "string", "peerNeId": "string", "remoteLagId": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string" ], "standbyState": "string", "systemId": "string", "systemPriority": 6 }, { "description": "string", "fdn": "string", "lacpKey": 1, "objectDetails": {}, "peerIpAddress": "string", "peerNeId": "string", "remoteLagId": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string", "systemId": "string", "systemPriority": 4 }, { "description": "string", "fdn": "string", "lacpKey": 8, "objectDetails": {}, "peerIpAddress": "string", "peerNeId": "string", "remoteLagId": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string", "systemId": "string", "systemPriority": 2 }, { "description": "string", "fdn": "string", "lacpKey": 10, "objectDetails": {}, "peerIpAddress": "string", "peerNeId": "string", "remoteLagId": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string" ], "standbyState": "string", "systemId": "string", "systemPriority": 8 }, { "description": "string", "fdn": "string", "lacpKey": 1, "objectDetails": {}, "peerIpAddress": "string", "peerNeId": "string", "remoteLagId": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string" ], "standbyState": "string", "systemId": "string", "systemPriority": 10 } ], "parentNe": "string", "parent": "string" } ] } } } }, "parameters": [ { "name": "networkElementFdn", "in": "path", "required": true, "schema": { "title": "networkElementFdn", "type": "string" } }, { "name": "filter", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/networkElements/{networkElementFdn}/lags/{lagFdn}/lagMembers": { "get": { "tags": [ "NetworkElements" ], "operationId": "getLagMembersUsingGET", "description": "The parameters and request body are for method: getLagMembersUsingGET. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "encapType": { "type": "string" }, "fdn": { "type": "string" }, "lagId": { "type": "string" }, "objectDetails": { "type": "object" }, "portFdn": { "type": "string" }, "portName": { "type": "string" }, "priority": { "type": "number" }, "sourceSystem": { "type": "string" }, "sourceType": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "standbyState": { "type": "string" } } } }, "example": [ { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 2, "sourceSystem": "string", "sourceType": "string", "sources": [ "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 4, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 10, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string" } ] } } } }, "parameters": [ { "name": "networkElementFdn", "in": "path", "required": true, "schema": { "title": "networkElementFdn", "type": "string" } }, { "name": "lagFdn", "in": "path", "required": true, "schema": { "title": "lagFdn", "type": "string" } }, { "name": "filter", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/networkElements/{networkElementFdn}/radioEquipment": { "get": { "tags": [ "NetworkElements" ], "operationId": "getNERadioEquipmentsUsingGET", "description": "The parameters and request body are for method: getNERadioEquipmentsUsingGET. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "adminState": { "type": "string" }, "availabilityStates": { "type": "array", "items": { "type": "string" } }, "chassisType": { "type": "string" }, "clliCode": { "type": "string" }, "communicationState": { "type": "string" }, "description": { "type": "string" }, "fdn": { "type": "string" }, "ipAddress": { "type": "string" }, "latitude": { "type": "number" }, "links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "type": "string" }, "templated": { "type": "boolean" } } } }, "location": { "type": "string" }, "longitude": { "type": "number" }, "macAddress": { "type": "string" }, "managedState": { "type": "string" }, "name": { "type": "string" }, "neId": { "type": "string" }, "neName": { "type": "string" }, "objectDetails": { "type": "object" }, "operState": { "type": "string" }, "parentNeName": { "type": "string" }, "product": { "type": "string" }, "resyncState": { "type": "string" }, "sourceSystem": { "type": "string" }, "sourceType": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "standbyState": { "type": "string" }, "systemAddress": { "type": "string" }, "version": { "type": "string" } } } }, "example": [ { "adminState": "string", "availabilityStates": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "chassisType": "string", "clliCode": "string", "communicationState": "string", "description": "string", "fdn": "string", "ipAddress": "string", "latitude": 1, "links": [ { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true } ], "location": "string", "longitude": 5, "macAddress": "string", "managedState": "string", "name": "string", "neId": "string", "neName": "string", "objectDetails": {}, "operState": "string", "parentNeName": "string", "product": "string", "resyncState": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string" ], "standbyState": "string", "systemAddress": "string", "version": "string" }, { "adminState": "string", "availabilityStates": [ "string", "string", "string", "string", "string", "string", "string", "string" ], "chassisType": "string", "clliCode": "string", "communicationState": "string", "description": "string", "fdn": "string", "ipAddress": "string", "latitude": 10, "links": [ { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true } ], "location": "string", "longitude": 9, "macAddress": "string", "managedState": "string", "name": "string", "neId": "string", "neName": "string", "objectDetails": {}, "operState": "string", "parentNeName": "string", "product": "string", "resyncState": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string", "systemAddress": "string", "version": "string" }, { "adminState": "string", "availabilityStates": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "chassisType": "string", "clliCode": "string", "communicationState": "string", "description": "string", "fdn": "string", "ipAddress": "string", "latitude": 10, "links": [ { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false } ], "location": "string", "longitude": 7, "macAddress": "string", "managedState": "string", "name": "string", "neId": "string", "neName": "string", "objectDetails": {}, "operState": "string", "parentNeName": "string", "product": "string", "resyncState": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string", "systemAddress": "string", "version": "string" }, { "adminState": "string", "availabilityStates": [ "string", "string", "string", "string", "string" ], "chassisType": "string", "clliCode": "string", "communicationState": "string", "description": "string", "fdn": "string", "ipAddress": "string", "latitude": 2, "links": [ { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true } ], "location": "string", "longitude": 2, "macAddress": "string", "managedState": "string", "name": "string", "neId": "string", "neName": "string", "objectDetails": {}, "operState": "string", "parentNeName": "string", "product": "string", "resyncState": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string", "systemAddress": "string", "version": "string" } ] } } } }, "parameters": [ { "name": "networkElementFdn", "in": "path", "required": true, "schema": { "title": "networkElementFdn", "type": "string" } }, { "name": "filter", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/networkElements/{networkElementFdn}/radioEquipment/{radioEquipmentFdn}/lags": { "get": { "tags": [ "NetworkElements" ], "operationId": "getRadioEquipmentLagsUsingGET", "description": "The parameters and request body are for method: getRadioEquipmentLagsUsingGET. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "type": "string" }, "templated": { "type": "boolean" } } } }, "fdn": { "type": "string" }, "sourceType": { "type": "object" }, "sourceSystem": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "lagId": { "type": "string" }, "neName": { "type": "string" }, "neId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "configuredAddress": { "type": "string" }, "encapType": { "type": "object" }, "operationalSpeedUnits": { "type": "string" }, "operationalSpeed": { "type": "number" }, "lagMode": { "type": "object" }, "adminState": { "type": "object" }, "operState": { "type": "object" }, "standbyState": { "type": "object" }, "availabilityStates": { "type": "array", "items": { "type": "string" } }, "stateReasons": { "type": "array", "items": { "type": "string" } }, "objectDetails": { "type": "object" }, "members": { "type": "array", "items": { "type": "object", "properties": { "encapType": { "type": "string" }, "fdn": { "type": "string" }, "lagId": { "type": "string" }, "objectDetails": { "type": "object" }, "portFdn": { "type": "string" }, "portName": { "type": "string" }, "priority": { "type": "number" }, "sourceSystem": { "type": "string" }, "sourceType": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "standbyState": { "type": "string" } } } }, "multiChassisLAGMembers": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "fdn": { "type": "string" }, "lacpKey": { "type": "number" }, "objectDetails": { "type": "object" }, "peerIpAddress": { "type": "string" }, "peerNeId": { "type": "string" }, "remoteLagId": { "type": "string" }, "sourceSystem": { "type": "string" }, "sourceType": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "standbyState": { "type": "string" }, "systemId": { "type": "string" }, "systemPriority": { "type": "number" } } } }, "parentNe": { "type": "string" }, "parent": { "type": "string" } } } }, "example": [ { "links": [ { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false } ], "fdn": "string", "sourceType": null, "sourceSystem": "string", "sources": [ "string", "string", "string", "string", "string" ], "lagId": "string", "neName": "string", "neId": "string", "name": "string", "description": "string", "configuredAddress": "string", "encapType": null, "operationalSpeedUnits": "string", "operationalSpeed": 1, "lagMode": null, "adminState": null, "operState": null, "standbyState": null, "availabilityStates": [ "logFull", "powerOff", "powerOff", "inTest", "degraded", "logFull" ], "stateReasons": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "objectDetails": {}, "members": [ { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 6, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 6, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 10, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 2, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 6, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 9, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 1, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 4, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string" } ], "multiChassisLAGMembers": [ { "description": "string", "fdn": "string", "lacpKey": 5, "objectDetails": {}, "peerIpAddress": "string", "peerNeId": "string", "remoteLagId": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string", "systemId": "string", "systemPriority": 2 }, { "description": "string", "fdn": "string", "lacpKey": 4, "objectDetails": {}, "peerIpAddress": "string", "peerNeId": "string", "remoteLagId": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string", "systemId": "string", "systemPriority": 8 }, { "description": "string", "fdn": "string", "lacpKey": 6, "objectDetails": {}, "peerIpAddress": "string", "peerNeId": "string", "remoteLagId": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string" ], "standbyState": "string", "systemId": "string", "systemPriority": 3 }, { "description": "string", "fdn": "string", "lacpKey": 2, "objectDetails": {}, "peerIpAddress": "string", "peerNeId": "string", "remoteLagId": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string" ], "standbyState": "string", "systemId": "string", "systemPriority": 8 } ], "parentNe": "string", "parent": "string" } ] } } } }, "parameters": [ { "name": "networkElementFdn", "in": "path", "required": true, "schema": { "title": "networkElementFdn", "type": "string" } }, { "name": "radioEquipmentFdn", "in": "path", "required": true, "schema": { "title": "radioEquipmentFdn", "type": "string" } }, { "name": "filter", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/networkElements/{networkElementFdn}/radioEquipment/{radioEquipmentFdn}/lags/{lagFdn}/lagMembers": { "get": { "tags": [ "NetworkElements" ], "operationId": "getRadioEquipmentLagMembersUsingGET", "description": "The parameters and request body are for method: getRadioEquipmentLagMembersUsingGET. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "encapType": { "type": "string" }, "fdn": { "type": "string" }, "lagId": { "type": "string" }, "objectDetails": { "type": "object" }, "portFdn": { "type": "string" }, "portName": { "type": "string" }, "priority": { "type": "number" }, "sourceSystem": { "type": "string" }, "sourceType": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "standbyState": { "type": "string" } } } }, "example": [ { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 1, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string" ], "standbyState": "string" } ] } } } }, "parameters": [ { "name": "networkElementFdn", "in": "path", "required": true, "schema": { "title": "networkElementFdn", "type": "string" } }, { "name": "radioEquipmentFdn", "in": "path", "required": true, "schema": { "title": "radioEquipmentFdn", "type": "string" } }, { "name": "lagFdn", "in": "path", "required": true, "schema": { "title": "lagFdn", "type": "string" } }, { "name": "filter", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/networkElements/{networkElementFdn}/radioEquipment/{radioEquipmentFdn}/shelves": { "get": { "tags": [ "NetworkElements" ], "operationId": "getRadioEquipmentShelvesUsingGET", "description": "The parameters and request body are for method: getRadioEquipmentShelvesUsingGET. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "type": "string" }, "templated": { "type": "boolean" } } } }, "fdn": { "type": "string" }, "sourceType": { "type": "object" }, "sourceSystem": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "neName": { "type": "string" }, "neId": { "type": "string" }, "description": { "type": "string" }, "positionId": { "type": "number" }, "position": { "type": "string" }, "adminState": { "type": "object" }, "operState": { "type": "object" }, "standbyState": { "type": "object" }, "availabilityStates": { "type": "array", "items": { "type": "string" } }, "stateReasons": { "type": "array", "items": { "type": "string" } }, "objectDetails": { "type": "object" }, "manufacturer": { "type": "string" }, "serialNumber": { "type": "string" }, "partNumber": { "type": "string" }, "manufacturerAssemblyNumber": { "type": "string" }, "manufactureDate": { "type": "string" }, "manufacturingDeviations": { "type": "string" }, "macAddress": { "type": "string" }, "hwMacAddress": { "type": "string" } } } }, "example": [ { "links": [ { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true } ], "fdn": "string", "sourceType": null, "sourceSystem": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string" ], "name": "string", "neName": "string", "neId": "string", "description": "string", "positionId": 5, "position": "string", "adminState": null, "operState": null, "standbyState": null, "availabilityStates": [ "unknown", "unknown", "logFull", "notInstalled", "logFull", "powerOff", "dependency" ], "stateReasons": [ "string", "string", "string" ], "objectDetails": {}, "manufacturer": "string", "serialNumber": "string", "partNumber": "string", "manufacturerAssemblyNumber": "string", "manufactureDate": "string", "manufacturingDeviations": "string", "macAddress": "string", "hwMacAddress": "string" } ] } } } }, "parameters": [ { "name": "networkElementFdn", "in": "path", "required": true, "schema": { "title": "networkElementFdn", "type": "string" } }, { "name": "radioEquipmentFdn", "in": "path", "required": true, "schema": { "title": "radioEquipmentFdn", "type": "string" } }, { "name": "filter", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/networkElements/{networkElementFdn}/radioEquipment/{radioEquipmentFdn}/shelves/{shelfFdn}/cards": { "get": { "tags": [ "NetworkElements" ], "operationId": "getRadioEquipmentShelfCardsUsingGET", "description": "The parameters and request body are for method: getRadioEquipmentShelfCardsUsingGET. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "type": "string" }, "templated": { "type": "boolean" } } } }, "fdn": { "type": "string" }, "sourceType": { "type": "object" }, "sourceSystem": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "neName": { "type": "string" }, "neId": { "type": "string" }, "description": { "type": "string" }, "positionId": { "type": "number" }, "position": { "type": "string" }, "adminState": { "type": "object" }, "operState": { "type": "object" }, "standbyState": { "type": "object" }, "availabilityStates": { "type": "array", "items": { "type": "string" } }, "stateReasons": { "type": "array", "items": { "type": "string" } }, "objectDetails": { "type": "object" }, "manufacturer": { "type": "string" }, "serialNumber": { "type": "string" }, "partNumber": { "type": "string" }, "manufacturerAssemblyNumber": { "type": "string" }, "manufactureDate": { "type": "string" }, "manufacturingDeviations": { "type": "string" }, "macAddress": { "type": "string" }, "hwMacAddress": { "type": "string" }, "cardDetails": { "type": "object", "properties": { "fdn": { "type": "string" }, "sourceType": { "type": "object" }, "sourceSystem": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "objectDetails": { "type": "object" }, "cardType": { "type": "string" }, "equippedPorts": { "type": "number" }, "capabilities": { "type": "array", "items": { "type": "string" } }, "availableSlots": { "type": "number" }, "installedSlots": { "type": "number" }, "memorySize": { "type": "number" }, "lastBootUpReason": { "type": "string" } } } } } }, "example": [ { "links": [ { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false } ], "fdn": "string", "sourceType": null, "sourceSystem": "string", "sources": [ "string", "string" ], "name": "string", "neName": "string", "neId": "string", "description": "string", "positionId": 3, "position": "string", "adminState": null, "operState": null, "standbyState": null, "availabilityStates": [ "dependency", "inTest", "failed", "notInstalled", "notInstalled", "offDuty", "degraded" ], "stateReasons": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "objectDetails": {}, "manufacturer": "string", "serialNumber": "string", "partNumber": "string", "manufacturerAssemblyNumber": "string", "manufactureDate": "string", "manufacturingDeviations": "string", "macAddress": "string", "hwMacAddress": "string", "cardDetails": { "fdn": "fdn:model:equipment:CardDetails:2203", "sourceType": null, "sourceSystem": "fdn:realm:sam", "sources": [ "fdn:realm:sam:network:38.120.169.111:shelf-1:cardSlot-2:card@cardDetails" ], "objectDetails": {}, "cardType": "500g CPM / Switch Fabric 3", "equippedPorts": 40, "capabilities": [ "string", "string", "string" ], "availableSlots": 2, "installedSlots": 1, "memorySize": 16392, "lastBootUpReason": "Hard Reboot" } } ] } } } }, "parameters": [ { "name": "networkElementFdn", "in": "path", "required": true, "schema": { "title": "networkElementFdn", "type": "string" } }, { "name": "radioEquipmentFdn", "in": "path", "required": true, "schema": { "title": "radioEquipmentFdn", "type": "string" } }, { "name": "shelfFdn", "in": "path", "required": true, "schema": { "title": "shelfFdn", "type": "string" } }, { "name": "filter", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/networkElements/{networkElementFdn}/radioEquipment/{radioEquipmentFdn}/shelves/{shelfFdn}/cards/{cardFdn}/ports": { "get": { "tags": [ "NetworkElements" ], "operationId": "getRadioEquipmentCardPortsUsingGET", "description": "The parameters and request body are for method: getRadioEquipmentCardPortsUsingGET. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "type": "string" }, "templated": { "type": "boolean" } } } }, "fdn": { "type": "string" }, "sourceType": { "type": "object" }, "sourceSystem": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "neName": { "type": "string" }, "neId": { "type": "string" }, "description": { "type": "string" }, "positionId": { "type": "number" }, "position": { "type": "string" }, "adminState": { "type": "object" }, "operState": { "type": "object" }, "standbyState": { "type": "object" }, "availabilityStates": { "type": "array", "items": { "type": "string" } }, "stateReasons": { "type": "array", "items": { "type": "string" } }, "objectDetails": { "type": "object" }, "manufacturer": { "type": "string" }, "serialNumber": { "type": "string" }, "partNumber": { "type": "string" }, "manufacturerAssemblyNumber": { "type": "string" }, "manufactureDate": { "type": "string" }, "manufacturingDeviations": { "type": "string" }, "macAddress": { "type": "string" }, "hwMacAddress": { "type": "string" }, "portDetails": { "type": "object", "properties": { "fdn": { "type": "string" }, "sourceType": { "type": "object" }, "sourceSystem": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "objectDetails": { "type": "object" }, "portIndex": { "type": "number" }, "portType": { "type": "object" }, "rate": { "type": "string" }, "actualRateUnits": { "type": "object" }, "actualRate": { "type": "number" }, "portMode": { "type": "object" }, "encapType": { "type": "object" }, "mtuValue": { "type": "number" } } }, "lagDetails": { "type": "object", "properties": { "encapType": { "type": "string" }, "fdn": { "type": "string" }, "lagId": { "type": "string" }, "objectDetails": { "type": "object" }, "portFdn": { "type": "string" }, "portName": { "type": "string" }, "priority": { "type": "number" }, "sourceSystem": { "type": "string" }, "sourceType": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "standbyState": { "type": "string" } } } } } }, "example": [ { "links": [ { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true } ], "fdn": "string", "sourceType": null, "sourceSystem": "string", "sources": [ "string", "string", "string" ], "name": "string", "neName": "string", "neId": "string", "description": "string", "positionId": 10, "position": "string", "adminState": null, "operState": null, "standbyState": null, "availabilityStates": [ "inTest", "dependency", "offLine", "offDuty", "dependency", "degraded", "failed" ], "stateReasons": [ "string" ], "objectDetails": {}, "manufacturer": "string", "serialNumber": "string", "partNumber": "string", "manufacturerAssemblyNumber": "string", "manufactureDate": "string", "manufacturingDeviations": "string", "macAddress": "string", "hwMacAddress": "string", "portDetails": { "fdn": "fdn:model:equipment:PortDetails:2209", "sourceType": null, "sourceSystem": "fdn:realm:sam", "sources": [ "fdn:realm:sam:network:38.120.169.111:shelf-1:cardSlot-2:card:port-1@portDetails" ], "objectDetails": {}, "portIndex": 67141632, "portType": null, "rate": "ethernet100", "actualRateUnits": null, "actualRate": 100000, "portMode": null, "encapType": null, "mtuValue": 1578 }, "lagDetails": { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 8, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string" ], "standbyState": "string" } }, { "links": [ { "href": "string", "rel": "string", "templated": true } ], "fdn": "string", "sourceType": null, "sourceSystem": "string", "sources": [ "string", "string", "string", "string" ], "name": "string", "neName": "string", "neId": "string", "description": "string", "positionId": 4, "position": "string", "adminState": null, "operState": null, "standbyState": null, "availabilityStates": [ "offDuty", "unknown", "offLine" ], "stateReasons": [ "string", "string" ], "objectDetails": {}, "manufacturer": "string", "serialNumber": "string", "partNumber": "string", "manufacturerAssemblyNumber": "string", "manufactureDate": "string", "manufacturingDeviations": "string", "macAddress": "string", "hwMacAddress": "string", "portDetails": { "fdn": "fdn:model:equipment:PortDetails:2209", "sourceType": null, "sourceSystem": "fdn:realm:sam", "sources": [ "fdn:realm:sam:network:38.120.169.111:shelf-1:cardSlot-2:card:port-1@portDetails" ], "objectDetails": {}, "portIndex": 67141632, "portType": null, "rate": "ethernet100", "actualRateUnits": null, "actualRate": 100000, "portMode": null, "encapType": null, "mtuValue": 1578 }, "lagDetails": { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 6, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string" } }, { "links": [ { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true } ], "fdn": "string", "sourceType": null, "sourceSystem": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string" ], "name": "string", "neName": "string", "neId": "string", "description": "string", "positionId": 6, "position": "string", "adminState": null, "operState": null, "standbyState": null, "availabilityStates": [ "offDuty" ], "stateReasons": [ "string", "string", "string", "string", "string", "string" ], "objectDetails": {}, "manufacturer": "string", "serialNumber": "string", "partNumber": "string", "manufacturerAssemblyNumber": "string", "manufactureDate": "string", "manufacturingDeviations": "string", "macAddress": "string", "hwMacAddress": "string", "portDetails": { "fdn": "fdn:model:equipment:PortDetails:2209", "sourceType": null, "sourceSystem": "fdn:realm:sam", "sources": [ "fdn:realm:sam:network:38.120.169.111:shelf-1:cardSlot-2:card:port-1@portDetails" ], "objectDetails": {}, "portIndex": 67141632, "portType": null, "rate": "ethernet100", "actualRateUnits": null, "actualRate": 100000, "portMode": null, "encapType": null, "mtuValue": 1578 }, "lagDetails": { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 4, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string" } }, { "links": [ { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true } ], "fdn": "string", "sourceType": null, "sourceSystem": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string" ], "name": "string", "neName": "string", "neId": "string", "description": "string", "positionId": 2, "position": "string", "adminState": null, "operState": null, "standbyState": null, "availabilityStates": [ "unknown", "dependency", "offLine", "dependency", "inTest", "failed", "inTest", "degraded", "unknown" ], "stateReasons": [ "string", "string", "string", "string", "string", "string", "string" ], "objectDetails": {}, "manufacturer": "string", "serialNumber": "string", "partNumber": "string", "manufacturerAssemblyNumber": "string", "manufactureDate": "string", "manufacturingDeviations": "string", "macAddress": "string", "hwMacAddress": "string", "portDetails": { "fdn": "fdn:model:equipment:PortDetails:2209", "sourceType": null, "sourceSystem": "fdn:realm:sam", "sources": [ "fdn:realm:sam:network:38.120.169.111:shelf-1:cardSlot-2:card:port-1@portDetails" ], "objectDetails": {}, "portIndex": 67141632, "portType": null, "rate": "ethernet100", "actualRateUnits": null, "actualRate": 100000, "portMode": null, "encapType": null, "mtuValue": 1578 }, "lagDetails": { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 1, "sourceSystem": "string", "sourceType": "string", "sources": [ "string" ], "standbyState": "string" } } ] } } } }, "parameters": [ { "name": "networkElementFdn", "in": "path", "required": true, "schema": { "title": "networkElementFdn", "type": "string" } }, { "name": "radioEquipmentFdn", "in": "path", "required": true, "schema": { "title": "radioEquipmentFdn", "type": "string" } }, { "name": "shelfFdn", "in": "path", "required": true, "schema": { "title": "shelfFdn", "type": "string" } }, { "name": "cardFdn", "in": "path", "required": true, "schema": { "title": "cardFdn", "type": "string" } }, { "name": "filter", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/networkElements/{networkElementFdn}/shelves": { "get": { "tags": [ "NetworkElements" ], "operationId": "getNEShelvesUsingGET", "description": "The parameters and request body are for method: getNEShelvesUsingGET. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "type": "string" }, "templated": { "type": "boolean" } } } }, "fdn": { "type": "string" }, "sourceType": { "type": "object" }, "sourceSystem": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "neName": { "type": "string" }, "neId": { "type": "string" }, "description": { "type": "string" }, "positionId": { "type": "number" }, "position": { "type": "string" }, "adminState": { "type": "object" }, "operState": { "type": "object" }, "standbyState": { "type": "object" }, "availabilityStates": { "type": "array", "items": { "type": "string" } }, "stateReasons": { "type": "array", "items": { "type": "string" } }, "objectDetails": { "type": "object" }, "manufacturer": { "type": "string" }, "serialNumber": { "type": "string" }, "partNumber": { "type": "string" }, "manufacturerAssemblyNumber": { "type": "string" }, "manufactureDate": { "type": "string" }, "manufacturingDeviations": { "type": "string" }, "macAddress": { "type": "string" }, "hwMacAddress": { "type": "string" } } } }, "example": [ { "links": [ { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false } ], "fdn": "string", "sourceType": null, "sourceSystem": "string", "sources": [ "string", "string" ], "name": "string", "neName": "string", "neId": "string", "description": "string", "positionId": 4, "position": "string", "adminState": null, "operState": null, "standbyState": null, "availabilityStates": [ "notInstalled", "dependency", "offDuty", "offLine", "dependency", "dependency", "inTest", "offLine", "offLine", "offLine" ], "stateReasons": [ "string", "string", "string", "string", "string", "string" ], "objectDetails": {}, "manufacturer": "string", "serialNumber": "string", "partNumber": "string", "manufacturerAssemblyNumber": "string", "manufactureDate": "string", "manufacturingDeviations": "string", "macAddress": "string", "hwMacAddress": "string" } ] } } } }, "parameters": [ { "name": "networkElementFdn", "in": "path", "required": true, "schema": { "title": "networkElementFdn", "type": "string" } }, { "name": "filter", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/networkElements/{networkElementFdn}/shelves/{shelfFdn}/cards": { "get": { "tags": [ "NetworkElements" ], "operationId": "getShelfCardsUsingGET", "description": "The parameters and request body are for method: getShelfCardsUsingGET. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "type": "string" }, "templated": { "type": "boolean" } } } }, "fdn": { "type": "string" }, "sourceType": { "type": "object" }, "sourceSystem": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "neName": { "type": "string" }, "neId": { "type": "string" }, "description": { "type": "string" }, "positionId": { "type": "number" }, "position": { "type": "string" }, "adminState": { "type": "object" }, "operState": { "type": "object" }, "standbyState": { "type": "object" }, "availabilityStates": { "type": "array", "items": { "type": "string" } }, "stateReasons": { "type": "array", "items": { "type": "string" } }, "objectDetails": { "type": "object" }, "manufacturer": { "type": "string" }, "serialNumber": { "type": "string" }, "partNumber": { "type": "string" }, "manufacturerAssemblyNumber": { "type": "string" }, "manufactureDate": { "type": "string" }, "manufacturingDeviations": { "type": "string" }, "macAddress": { "type": "string" }, "hwMacAddress": { "type": "string" }, "cardDetails": { "type": "object", "properties": { "fdn": { "type": "string" }, "sourceType": { "type": "object" }, "sourceSystem": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "objectDetails": { "type": "object" }, "cardType": { "type": "string" }, "equippedPorts": { "type": "number" }, "capabilities": { "type": "array", "items": { "type": "string" } }, "availableSlots": { "type": "number" }, "installedSlots": { "type": "number" }, "memorySize": { "type": "number" }, "lastBootUpReason": { "type": "string" } } } } } }, "example": [ { "links": [ { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true } ], "fdn": "string", "sourceType": null, "sourceSystem": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string" ], "name": "string", "neName": "string", "neId": "string", "description": "string", "positionId": 7, "position": "string", "adminState": null, "operState": null, "standbyState": null, "availabilityStates": [ "failed", "degraded", "degraded", "powerOff", "degraded", "notInstalled", "offDuty", "inTest", "offLine", "dependency" ], "stateReasons": [ "string" ], "objectDetails": {}, "manufacturer": "string", "serialNumber": "string", "partNumber": "string", "manufacturerAssemblyNumber": "string", "manufactureDate": "string", "manufacturingDeviations": "string", "macAddress": "string", "hwMacAddress": "string", "cardDetails": { "fdn": "fdn:model:equipment:CardDetails:2203", "sourceType": null, "sourceSystem": "fdn:realm:sam", "sources": [ "fdn:realm:sam:network:38.120.169.111:shelf-1:cardSlot-2:card@cardDetails" ], "objectDetails": {}, "cardType": "500g CPM / Switch Fabric 3", "equippedPorts": 40, "capabilities": [ "string", "string" ], "availableSlots": 2, "installedSlots": 1, "memorySize": 16392, "lastBootUpReason": "Hard Reboot" } }, { "links": [ { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false } ], "fdn": "string", "sourceType": null, "sourceSystem": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "name": "string", "neName": "string", "neId": "string", "description": "string", "positionId": 7, "position": "string", "adminState": null, "operState": null, "standbyState": null, "availabilityStates": [ "inTest", "dependency", "failed", "notInstalled", "powerOff", "notInstalled", "degraded" ], "stateReasons": [ "string", "string", "string", "string", "string", "string" ], "objectDetails": {}, "manufacturer": "string", "serialNumber": "string", "partNumber": "string", "manufacturerAssemblyNumber": "string", "manufactureDate": "string", "manufacturingDeviations": "string", "macAddress": "string", "hwMacAddress": "string", "cardDetails": { "fdn": "fdn:model:equipment:CardDetails:2203", "sourceType": null, "sourceSystem": "fdn:realm:sam", "sources": [ "fdn:realm:sam:network:38.120.169.111:shelf-1:cardSlot-2:card@cardDetails" ], "objectDetails": {}, "cardType": "500g CPM / Switch Fabric 3", "equippedPorts": 40, "capabilities": [ "string", "string" ], "availableSlots": 2, "installedSlots": 1, "memorySize": 16392, "lastBootUpReason": "Hard Reboot" } } ] } } } }, "parameters": [ { "name": "networkElementFdn", "in": "path", "required": true, "schema": { "title": "networkElementFdn", "type": "string" } }, { "name": "shelfFdn", "in": "path", "required": true, "schema": { "title": "shelfFdn", "type": "string" } }, { "name": "filter", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/networkElements/{networkElementFdn}/shelves/{shelfFdn}/cards/{cardFdn}/ports": { "get": { "tags": [ "NetworkElements" ], "operationId": "getCardPortsUsingGET", "description": "The parameters and request body are for method: getCardPortsUsingGET. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "type": "string" }, "templated": { "type": "boolean" } } } }, "fdn": { "type": "string" }, "sourceType": { "type": "object" }, "sourceSystem": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "neName": { "type": "string" }, "neId": { "type": "string" }, "description": { "type": "string" }, "positionId": { "type": "number" }, "position": { "type": "string" }, "adminState": { "type": "object" }, "operState": { "type": "object" }, "standbyState": { "type": "object" }, "availabilityStates": { "type": "array", "items": { "type": "string" } }, "stateReasons": { "type": "array", "items": { "type": "string" } }, "objectDetails": { "type": "object" }, "manufacturer": { "type": "string" }, "serialNumber": { "type": "string" }, "partNumber": { "type": "string" }, "manufacturerAssemblyNumber": { "type": "string" }, "manufactureDate": { "type": "string" }, "manufacturingDeviations": { "type": "string" }, "macAddress": { "type": "string" }, "hwMacAddress": { "type": "string" }, "portDetails": { "type": "object", "properties": { "fdn": { "type": "string" }, "sourceType": { "type": "object" }, "sourceSystem": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "objectDetails": { "type": "object" }, "portIndex": { "type": "number" }, "portType": { "type": "object" }, "rate": { "type": "string" }, "actualRateUnits": { "type": "object" }, "actualRate": { "type": "number" }, "portMode": { "type": "object" }, "encapType": { "type": "object" }, "mtuValue": { "type": "number" } } }, "lagDetails": { "type": "object", "properties": { "encapType": { "type": "string" }, "fdn": { "type": "string" }, "lagId": { "type": "string" }, "objectDetails": { "type": "object" }, "portFdn": { "type": "string" }, "portName": { "type": "string" }, "priority": { "type": "number" }, "sourceSystem": { "type": "string" }, "sourceType": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "standbyState": { "type": "string" } } } } } }, "example": [ { "links": [ { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false } ], "fdn": "string", "sourceType": null, "sourceSystem": "string", "sources": [ "string", "string", "string" ], "name": "string", "neName": "string", "neId": "string", "description": "string", "positionId": 9, "position": "string", "adminState": null, "operState": null, "standbyState": null, "availabilityStates": [ "dependency" ], "stateReasons": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "objectDetails": {}, "manufacturer": "string", "serialNumber": "string", "partNumber": "string", "manufacturerAssemblyNumber": "string", "manufactureDate": "string", "manufacturingDeviations": "string", "macAddress": "string", "hwMacAddress": "string", "portDetails": { "fdn": "fdn:model:equipment:PortDetails:2209", "sourceType": null, "sourceSystem": "fdn:realm:sam", "sources": [ "fdn:realm:sam:network:38.120.169.111:shelf-1:cardSlot-2:card:port-1@portDetails" ], "objectDetails": {}, "portIndex": 67141632, "portType": null, "rate": "ethernet100", "actualRateUnits": null, "actualRate": 100000, "portMode": null, "encapType": null, "mtuValue": 1578 }, "lagDetails": { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 9, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string" ], "standbyState": "string" } }, { "links": [ { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false } ], "fdn": "string", "sourceType": null, "sourceSystem": "string", "sources": [ "string" ], "name": "string", "neName": "string", "neId": "string", "description": "string", "positionId": 3, "position": "string", "adminState": null, "operState": null, "standbyState": null, "availabilityStates": [ "powerOff", "inTest", "powerOff", "degraded", "powerOff", "dependency" ], "stateReasons": [ "string", "string", "string", "string", "string", "string", "string", "string" ], "objectDetails": {}, "manufacturer": "string", "serialNumber": "string", "partNumber": "string", "manufacturerAssemblyNumber": "string", "manufactureDate": "string", "manufacturingDeviations": "string", "macAddress": "string", "hwMacAddress": "string", "portDetails": { "fdn": "fdn:model:equipment:PortDetails:2209", "sourceType": null, "sourceSystem": "fdn:realm:sam", "sources": [ "fdn:realm:sam:network:38.120.169.111:shelf-1:cardSlot-2:card:port-1@portDetails" ], "objectDetails": {}, "portIndex": 67141632, "portType": null, "rate": "ethernet100", "actualRateUnits": null, "actualRate": 100000, "portMode": null, "encapType": null, "mtuValue": 1578 }, "lagDetails": { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 8, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string" ], "standbyState": "string" } } ] } } } }, "parameters": [ { "name": "networkElementFdn", "in": "path", "required": true, "schema": { "title": "networkElementFdn", "type": "string" } }, { "name": "shelfFdn", "in": "path", "required": true, "schema": { "title": "shelfFdn", "type": "string" } }, { "name": "cardFdn", "in": "path", "required": true, "schema": { "title": "cardFdn", "type": "string" } }, { "name": "filter", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/networkElements/{networkElementFdn}/shelves/{shelfFdn}/ports": { "get": { "tags": [ "NetworkElements" ], "operationId": "getShelfPortsUsingGET", "description": "The parameters and request body are for method: getShelfPortsUsingGET. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "type": "string" }, "templated": { "type": "boolean" } } } }, "fdn": { "type": "string" }, "sourceType": { "type": "object" }, "sourceSystem": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "neName": { "type": "string" }, "neId": { "type": "string" }, "description": { "type": "string" }, "positionId": { "type": "number" }, "position": { "type": "string" }, "adminState": { "type": "object" }, "operState": { "type": "object" }, "standbyState": { "type": "object" }, "availabilityStates": { "type": "array", "items": { "type": "string" } }, "stateReasons": { "type": "array", "items": { "type": "string" } }, "objectDetails": { "type": "object" }, "manufacturer": { "type": "string" }, "serialNumber": { "type": "string" }, "partNumber": { "type": "string" }, "manufacturerAssemblyNumber": { "type": "string" }, "manufactureDate": { "type": "string" }, "manufacturingDeviations": { "type": "string" }, "macAddress": { "type": "string" }, "hwMacAddress": { "type": "string" }, "portDetails": { "type": "object", "properties": { "fdn": { "type": "string" }, "sourceType": { "type": "object" }, "sourceSystem": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "objectDetails": { "type": "object" }, "portIndex": { "type": "number" }, "portType": { "type": "object" }, "rate": { "type": "string" }, "actualRateUnits": { "type": "object" }, "actualRate": { "type": "number" }, "portMode": { "type": "object" }, "encapType": { "type": "object" }, "mtuValue": { "type": "number" } } }, "lagDetails": { "type": "object", "properties": { "encapType": { "type": "string" }, "fdn": { "type": "string" }, "lagId": { "type": "string" }, "objectDetails": { "type": "object" }, "portFdn": { "type": "string" }, "portName": { "type": "string" }, "priority": { "type": "number" }, "sourceSystem": { "type": "string" }, "sourceType": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "standbyState": { "type": "string" } } } } } }, "example": [ { "links": [ { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false } ], "fdn": "string", "sourceType": null, "sourceSystem": "string", "sources": [ "string", "string" ], "name": "string", "neName": "string", "neId": "string", "description": "string", "positionId": 8, "position": "string", "adminState": null, "operState": null, "standbyState": null, "availabilityStates": [ "inTest", "inTest", "powerOff", "degraded", "logFull", "powerOff", "failed", "powerOff", "offLine", "inTest" ], "stateReasons": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "objectDetails": {}, "manufacturer": "string", "serialNumber": "string", "partNumber": "string", "manufacturerAssemblyNumber": "string", "manufactureDate": "string", "manufacturingDeviations": "string", "macAddress": "string", "hwMacAddress": "string", "portDetails": { "fdn": "fdn:model:equipment:PortDetails:2209", "sourceType": null, "sourceSystem": "fdn:realm:sam", "sources": [ "fdn:realm:sam:network:38.120.169.111:shelf-1:cardSlot-2:card:port-1@portDetails" ], "objectDetails": {}, "portIndex": 67141632, "portType": null, "rate": "ethernet100", "actualRateUnits": null, "actualRate": 100000, "portMode": null, "encapType": null, "mtuValue": 1578 }, "lagDetails": { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 9, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string" ], "standbyState": "string" } }, { "links": [ { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true } ], "fdn": "string", "sourceType": null, "sourceSystem": "string", "sources": [ "string", "string" ], "name": "string", "neName": "string", "neId": "string", "description": "string", "positionId": 1, "position": "string", "adminState": null, "operState": null, "standbyState": null, "availabilityStates": [ "powerOff" ], "stateReasons": [ "string", "string", "string", "string", "string", "string", "string", "string" ], "objectDetails": {}, "manufacturer": "string", "serialNumber": "string", "partNumber": "string", "manufacturerAssemblyNumber": "string", "manufactureDate": "string", "manufacturingDeviations": "string", "macAddress": "string", "hwMacAddress": "string", "portDetails": { "fdn": "fdn:model:equipment:PortDetails:2209", "sourceType": null, "sourceSystem": "fdn:realm:sam", "sources": [ "fdn:realm:sam:network:38.120.169.111:shelf-1:cardSlot-2:card:port-1@portDetails" ], "objectDetails": {}, "portIndex": 67141632, "portType": null, "rate": "ethernet100", "actualRateUnits": null, "actualRate": 100000, "portMode": null, "encapType": null, "mtuValue": 1578 }, "lagDetails": { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 9, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string" ], "standbyState": "string" } }, { "links": [ { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false } ], "fdn": "string", "sourceType": null, "sourceSystem": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "name": "string", "neName": "string", "neId": "string", "description": "string", "positionId": 5, "position": "string", "adminState": null, "operState": null, "standbyState": null, "availabilityStates": [ "powerOff", "offDuty", "dependency", "unknown", "logFull", "offDuty", "offLine", "inTest" ], "stateReasons": [ "string", "string", "string", "string", "string", "string" ], "objectDetails": {}, "manufacturer": "string", "serialNumber": "string", "partNumber": "string", "manufacturerAssemblyNumber": "string", "manufactureDate": "string", "manufacturingDeviations": "string", "macAddress": "string", "hwMacAddress": "string", "portDetails": { "fdn": "fdn:model:equipment:PortDetails:2209", "sourceType": null, "sourceSystem": "fdn:realm:sam", "sources": [ "fdn:realm:sam:network:38.120.169.111:shelf-1:cardSlot-2:card:port-1@portDetails" ], "objectDetails": {}, "portIndex": 67141632, "portType": null, "rate": "ethernet100", "actualRateUnits": null, "actualRate": 100000, "portMode": null, "encapType": null, "mtuValue": 1578 }, "lagDetails": { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 8, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string" } } ] } } } }, "parameters": [ { "name": "networkElementFdn", "in": "path", "required": true, "schema": { "title": "networkElementFdn", "type": "string" } }, { "name": "shelfFdn", "in": "path", "required": true, "schema": { "title": "shelfFdn", "type": "string" } }, { "name": "filter", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/physicalLinks": { "get": { "tags": [ "PhysicalLinks" ], "operationId": "getPhysicalLinksUsingGET", "description": "The parameters and request body are for method: getPhysicalLinksUsingGET. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "type": "string" }, "templated": { "type": "boolean" } } } }, "sourceType": { "type": "string" }, "fdn": { "type": "string" }, "sourceSystem": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "id": { "type": "string" }, "type": { "type": "string" }, "rate": { "type": "string" }, "actualRate": { "type": "number" }, "actualRateUnits": { "type": "object" }, "description": { "type": "string" }, "protection": { "type": "object" }, "protectionKind": { "type": "object" }, "latency": { "type": "number" }, "latencyUnits": { "type": "object" }, "restoration": { "type": "object" }, "direction": { "type": "object" }, "adminState": { "type": "object" }, "operState": { "type": "object" }, "standbyState": { "type": "object" }, "availabilityStates": { "type": "array", "items": { "type": "string" } }, "objectDetails": { "type": "object" }, "endpoints": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "object" }, "port": { "type": "string" }, "lag": { "type": "string" }, "parentNe": { "type": "string" }, "parentNeId": { "type": "string" }, "subnetName": { "type": "string" }, "objectDetails": { "type": "object" }, "parentNeName": { "type": "string" } } } } } } }, "example": [ { "links": [ { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false } ], "sourceType": "string", "fdn": "string", "sourceSystem": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string" ], "name": "string", "id": "string", "type": "cable", "rate": "string", "actualRate": 8, "actualRateUnits": null, "description": "string", "protection": null, "protectionKind": null, "latency": 3, "latencyUnits": null, "restoration": null, "direction": null, "adminState": null, "operState": null, "standbyState": null, "availabilityStates": [ "notInstalled", "powerOff", "degraded", "failed" ], "objectDetails": {}, "endpoints": [ { "name": "Port 1/1/1", "type": null, "port": "fdn:model:equipment:Equipment:2189", "lag": "null", "parentNe": "fdn:model:equipment:NetworkElement:2102", "parentNeId": "38.120.169.111", "subnetName": "null", "objectDetails": {}, "parentNeName": "string" }, { "name": "Port 1/1/1", "type": null, "port": "fdn:model:equipment:Equipment:2189", "lag": "null", "parentNe": "fdn:model:equipment:NetworkElement:2102", "parentNeId": "38.120.169.111", "subnetName": "null", "objectDetails": {}, "parentNeName": "string" }, { "name": "Port 1/1/1", "type": null, "port": "fdn:model:equipment:Equipment:2189", "lag": "null", "parentNe": "fdn:model:equipment:NetworkElement:2102", "parentNeId": "38.120.169.111", "subnetName": "null", "objectDetails": {}, "parentNeName": "string" }, { "name": "Port 1/1/1", "type": null, "port": "fdn:model:equipment:Equipment:2189", "lag": "null", "parentNe": "fdn:model:equipment:NetworkElement:2102", "parentNeId": "38.120.169.111", "subnetName": "null", "objectDetails": {}, "parentNeName": "string" } ] }, { "links": [ { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false } ], "sourceType": "string", "fdn": "string", "sourceSystem": "string", "sources": [ "string", "string", "string", "string", "string", "string" ], "name": "string", "id": "string", "type": "cable", "rate": "string", "actualRate": 3, "actualRateUnits": null, "description": "string", "protection": null, "protectionKind": null, "latency": 10, "latencyUnits": null, "restoration": null, "direction": null, "adminState": null, "operState": null, "standbyState": null, "availabilityStates": [ "logFull", "dependency", "dependency", "unknown", "failed", "offDuty", "powerOff", "inTest", "degraded" ], "objectDetails": {}, "endpoints": [ { "name": "Port 1/1/1", "type": null, "port": "fdn:model:equipment:Equipment:2189", "lag": "null", "parentNe": "fdn:model:equipment:NetworkElement:2102", "parentNeId": "38.120.169.111", "subnetName": "null", "objectDetails": {}, "parentNeName": "string" }, { "name": "Port 1/1/1", "type": null, "port": "fdn:model:equipment:Equipment:2189", "lag": "null", "parentNe": "fdn:model:equipment:NetworkElement:2102", "parentNeId": "38.120.169.111", "subnetName": "null", "objectDetails": {}, "parentNeName": "string" }, { "name": "Port 1/1/1", "type": null, "port": "fdn:model:equipment:Equipment:2189", "lag": "null", "parentNe": "fdn:model:equipment:NetworkElement:2102", "parentNeId": "38.120.169.111", "subnetName": "null", "objectDetails": {}, "parentNeName": "string" }, { "name": "Port 1/1/1", "type": null, "port": "fdn:model:equipment:Equipment:2189", "lag": "null", "parentNe": "fdn:model:equipment:NetworkElement:2102", "parentNeId": "38.120.169.111", "subnetName": "null", "objectDetails": {}, "parentNeName": "string" }, { "name": "Port 1/1/1", "type": null, "port": "fdn:model:equipment:Equipment:2189", "lag": "null", "parentNe": "fdn:model:equipment:NetworkElement:2102", "parentNeId": "38.120.169.111", "subnetName": "null", "objectDetails": {}, "parentNeName": "string" }, { "name": "Port 1/1/1", "type": null, "port": "fdn:model:equipment:Equipment:2189", "lag": "null", "parentNe": "fdn:model:equipment:NetworkElement:2102", "parentNeId": "38.120.169.111", "subnetName": "null", "objectDetails": {}, "parentNeName": "string" }, { "name": "Port 1/1/1", "type": null, "port": "fdn:model:equipment:Equipment:2189", "lag": "null", "parentNe": "fdn:model:equipment:NetworkElement:2102", "parentNeId": "38.120.169.111", "subnetName": "null", "objectDetails": {}, "parentNeName": "string" }, { "name": "Port 1/1/1", "type": null, "port": "fdn:model:equipment:Equipment:2189", "lag": "null", "parentNe": "fdn:model:equipment:NetworkElement:2102", "parentNeId": "38.120.169.111", "subnetName": "null", "objectDetails": {}, "parentNeName": "string" }, { "name": "Port 1/1/1", "type": null, "port": "fdn:model:equipment:Equipment:2189", "lag": "null", "parentNe": "fdn:model:equipment:NetworkElement:2102", "parentNeId": "38.120.169.111", "subnetName": "null", "objectDetails": {}, "parentNeName": "string" }, { "name": "Port 1/1/1", "type": null, "port": "fdn:model:equipment:Equipment:2189", "lag": "null", "parentNe": "fdn:model:equipment:NetworkElement:2102", "parentNeId": "38.120.169.111", "subnetName": "null", "objectDetails": {}, "parentNeName": "string" } ] } ] } } } }, "parameters": [ { "name": "fdns", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "neFetch", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "PhysicalLinks" ], "operationId": "createPhysicalLinkUsingPOST", "description": "The parameters and request body are for method: createPhysicalLinkUsingPOST. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "physicalLink" } } } } }, "/v1/physicalLinks/{physicalLinkFdn}": { "get": { "tags": [ "PhysicalLinks" ], "operationId": "getPhysicalLinkUsingGET", "description": "The parameters and request body are for method: getPhysicalLinkUsingGET. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "physicalLinkFdn", "in": "path", "required": true, "schema": { "title": "physicalLinkFdn", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "delete": { "tags": [ "PhysicalLinks" ], "operationId": "deletePhysicalLinkUsingDELETE", "description": "The parameters and request body are for method: deletePhysicalLinkUsingDELETE. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "physicalLinkFdn", "in": "path", "required": true, "schema": { "title": "physicalLinkFdn", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/ports": { "get": { "tags": [ "Ports" ], "operationId": "getPortsUsingGET", "description": "The parameters and request body are for method: getPortsUsingGET. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "type": "string" }, "templated": { "type": "boolean" } } } }, "fdn": { "type": "string" }, "sourceType": { "type": "object" }, "sourceSystem": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "neName": { "type": "string" }, "neId": { "type": "string" }, "description": { "type": "string" }, "positionId": { "type": "number" }, "position": { "type": "string" }, "adminState": { "type": "object" }, "operState": { "type": "object" }, "standbyState": { "type": "object" }, "availabilityStates": { "type": "array", "items": { "type": "string" } }, "stateReasons": { "type": "array", "items": { "type": "string" } }, "objectDetails": { "type": "object" }, "manufacturer": { "type": "string" }, "serialNumber": { "type": "string" }, "partNumber": { "type": "string" }, "manufacturerAssemblyNumber": { "type": "string" }, "manufactureDate": { "type": "string" }, "manufacturingDeviations": { "type": "string" }, "macAddress": { "type": "string" }, "hwMacAddress": { "type": "string" }, "portDetails": { "type": "object", "properties": { "fdn": { "type": "string" }, "sourceType": { "type": "object" }, "sourceSystem": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "objectDetails": { "type": "object" }, "portIndex": { "type": "number" }, "portType": { "type": "object" }, "rate": { "type": "string" }, "actualRateUnits": { "type": "object" }, "actualRate": { "type": "number" }, "portMode": { "type": "object" }, "encapType": { "type": "object" }, "mtuValue": { "type": "number" } } }, "lagDetails": { "type": "object", "properties": { "encapType": { "type": "string" }, "fdn": { "type": "string" }, "lagId": { "type": "string" }, "objectDetails": { "type": "object" }, "portFdn": { "type": "string" }, "portName": { "type": "string" }, "priority": { "type": "number" }, "sourceSystem": { "type": "string" }, "sourceType": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "standbyState": { "type": "string" } } } } } }, "example": [ { "links": [ { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true } ], "fdn": "string", "sourceType": null, "sourceSystem": "string", "sources": [ "string", "string", "string", "string" ], "name": "string", "neName": "string", "neId": "string", "description": "string", "positionId": 10, "position": "string", "adminState": null, "operState": null, "standbyState": null, "availabilityStates": [ "offDuty", "dependency", "logFull", "failed", "inTest", "notInstalled", "powerOff", "logFull" ], "stateReasons": [ "string", "string", "string", "string", "string", "string", "string", "string" ], "objectDetails": {}, "manufacturer": "string", "serialNumber": "string", "partNumber": "string", "manufacturerAssemblyNumber": "string", "manufactureDate": "string", "manufacturingDeviations": "string", "macAddress": "string", "hwMacAddress": "string", "portDetails": { "fdn": "fdn:model:equipment:PortDetails:2209", "sourceType": null, "sourceSystem": "fdn:realm:sam", "sources": [ "fdn:realm:sam:network:38.120.169.111:shelf-1:cardSlot-2:card:port-1@portDetails" ], "objectDetails": {}, "portIndex": 67141632, "portType": null, "rate": "ethernet100", "actualRateUnits": null, "actualRate": 100000, "portMode": null, "encapType": null, "mtuValue": 1578 }, "lagDetails": { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 5, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string" ], "standbyState": "string" } }, { "links": [ { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true } ], "fdn": "string", "sourceType": null, "sourceSystem": "string", "sources": [ "string", "string" ], "name": "string", "neName": "string", "neId": "string", "description": "string", "positionId": 4, "position": "string", "adminState": null, "operState": null, "standbyState": null, "availabilityStates": [ "logFull", "degraded", "powerOff", "notInstalled", "inTest", "offLine", "offDuty" ], "stateReasons": [ "string", "string", "string", "string" ], "objectDetails": {}, "manufacturer": "string", "serialNumber": "string", "partNumber": "string", "manufacturerAssemblyNumber": "string", "manufactureDate": "string", "manufacturingDeviations": "string", "macAddress": "string", "hwMacAddress": "string", "portDetails": { "fdn": "fdn:model:equipment:PortDetails:2209", "sourceType": null, "sourceSystem": "fdn:realm:sam", "sources": [ "fdn:realm:sam:network:38.120.169.111:shelf-1:cardSlot-2:card:port-1@portDetails" ], "objectDetails": {}, "portIndex": 67141632, "portType": null, "rate": "ethernet100", "actualRateUnits": null, "actualRate": 100000, "portMode": null, "encapType": null, "mtuValue": 1578 }, "lagDetails": { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 4, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string" } }, { "links": [ { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true } ], "fdn": "string", "sourceType": null, "sourceSystem": "string", "sources": [ "string", "string", "string", "string" ], "name": "string", "neName": "string", "neId": "string", "description": "string", "positionId": 5, "position": "string", "adminState": null, "operState": null, "standbyState": null, "availabilityStates": [ "failed", "inTest", "powerOff", "dependency", "failed", "inTest", "offLine", "dependency" ], "stateReasons": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "objectDetails": {}, "manufacturer": "string", "serialNumber": "string", "partNumber": "string", "manufacturerAssemblyNumber": "string", "manufactureDate": "string", "manufacturingDeviations": "string", "macAddress": "string", "hwMacAddress": "string", "portDetails": { "fdn": "fdn:model:equipment:PortDetails:2209", "sourceType": null, "sourceSystem": "fdn:realm:sam", "sources": [ "fdn:realm:sam:network:38.120.169.111:shelf-1:cardSlot-2:card:port-1@portDetails" ], "objectDetails": {}, "portIndex": 67141632, "portType": null, "rate": "ethernet100", "actualRateUnits": null, "actualRate": 100000, "portMode": null, "encapType": null, "mtuValue": 1578 }, "lagDetails": { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 5, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string" ], "standbyState": "string" } }, { "links": [ { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false } ], "fdn": "string", "sourceType": null, "sourceSystem": "string", "sources": [ "string", "string", "string", "string", "string" ], "name": "string", "neName": "string", "neId": "string", "description": "string", "positionId": 1, "position": "string", "adminState": null, "operState": null, "standbyState": null, "availabilityStates": [ "degraded", "inTest", "offLine", "unknown", "powerOff", "unknown", "failed", "unknown", "dependency" ], "stateReasons": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "objectDetails": {}, "manufacturer": "string", "serialNumber": "string", "partNumber": "string", "manufacturerAssemblyNumber": "string", "manufactureDate": "string", "manufacturingDeviations": "string", "macAddress": "string", "hwMacAddress": "string", "portDetails": { "fdn": "fdn:model:equipment:PortDetails:2209", "sourceType": null, "sourceSystem": "fdn:realm:sam", "sources": [ "fdn:realm:sam:network:38.120.169.111:shelf-1:cardSlot-2:card:port-1@portDetails" ], "objectDetails": {}, "portIndex": 67141632, "portType": null, "rate": "ethernet100", "actualRateUnits": null, "actualRate": 100000, "portMode": null, "encapType": null, "mtuValue": 1578 }, "lagDetails": { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 2, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string" ], "standbyState": "string" } } ] } } } }, "parameters": [ { "name": "fdns", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/ports/{portFdn}": { "get": { "tags": [ "Ports" ], "operationId": "getPortUsingGET", "description": "The parameters and request body are for method: getPortUsingGET. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "portFdn", "in": "path", "required": true, "schema": { "title": "portFdn", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/radioEquipment": { "get": { "tags": [ "RadioEquipment" ], "operationId": "getRadioEquipmentsUsingGET", "description": "The parameters and request body are for method: getRadioEquipmentsUsingGET. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "adminState": { "type": "string" }, "availabilityStates": { "type": "array", "items": { "type": "string" } }, "chassisType": { "type": "string" }, "clliCode": { "type": "string" }, "communicationState": { "type": "string" }, "description": { "type": "string" }, "fdn": { "type": "string" }, "ipAddress": { "type": "string" }, "latitude": { "type": "number" }, "links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "type": "string" }, "templated": { "type": "boolean" } } } }, "location": { "type": "string" }, "longitude": { "type": "number" }, "macAddress": { "type": "string" }, "managedState": { "type": "string" }, "name": { "type": "string" }, "neId": { "type": "string" }, "neName": { "type": "string" }, "objectDetails": { "type": "object" }, "operState": { "type": "string" }, "parentNeName": { "type": "string" }, "product": { "type": "string" }, "resyncState": { "type": "string" }, "sourceSystem": { "type": "string" }, "sourceType": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "standbyState": { "type": "string" }, "systemAddress": { "type": "string" }, "version": { "type": "string" } } } }, "example": [ { "adminState": "string", "availabilityStates": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "chassisType": "string", "clliCode": "string", "communicationState": "string", "description": "string", "fdn": "string", "ipAddress": "string", "latitude": 6, "links": [ { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false } ], "location": "string", "longitude": 9, "macAddress": "string", "managedState": "string", "name": "string", "neId": "string", "neName": "string", "objectDetails": {}, "operState": "string", "parentNeName": "string", "product": "string", "resyncState": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string", "systemAddress": "string", "version": "string" } ] } } } }, "parameters": [ { "name": "fdns", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/radioEquipment/{radioEquipmentFdn}": { "get": { "tags": [ "RadioEquipment" ], "operationId": "getRadioEquipmentUsingGET", "description": "The parameters and request body are for method: getRadioEquipmentUsingGET. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "radioEquipmentFdn", "in": "path", "required": true, "schema": { "title": "radioEquipmentFdn", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/shelves": { "get": { "tags": [ "Shelves" ], "operationId": "getShelvesUsingGET", "description": "The parameters and request body are for method: getShelvesUsingGET. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "type": "string" }, "templated": { "type": "boolean" } } } }, "fdn": { "type": "string" }, "sourceType": { "type": "object" }, "sourceSystem": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "neName": { "type": "string" }, "neId": { "type": "string" }, "description": { "type": "string" }, "positionId": { "type": "number" }, "position": { "type": "string" }, "adminState": { "type": "object" }, "operState": { "type": "object" }, "standbyState": { "type": "object" }, "availabilityStates": { "type": "array", "items": { "type": "string" } }, "stateReasons": { "type": "array", "items": { "type": "string" } }, "objectDetails": { "type": "object" }, "manufacturer": { "type": "string" }, "serialNumber": { "type": "string" }, "partNumber": { "type": "string" }, "manufacturerAssemblyNumber": { "type": "string" }, "manufactureDate": { "type": "string" }, "manufacturingDeviations": { "type": "string" }, "macAddress": { "type": "string" }, "hwMacAddress": { "type": "string" } } } }, "example": [ { "links": [ { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false } ], "fdn": "string", "sourceType": null, "sourceSystem": "string", "sources": [ "string", "string" ], "name": "string", "neName": "string", "neId": "string", "description": "string", "positionId": 10, "position": "string", "adminState": null, "operState": null, "standbyState": null, "availabilityStates": [ "inTest", "offDuty", "failed", "degraded", "powerOff", "powerOff", "notInstalled", "inTest" ], "stateReasons": [ "string", "string", "string", "string", "string", "string", "string" ], "objectDetails": {}, "manufacturer": "string", "serialNumber": "string", "partNumber": "string", "manufacturerAssemblyNumber": "string", "manufactureDate": "string", "manufacturingDeviations": "string", "macAddress": "string", "hwMacAddress": "string" } ] } } } }, "parameters": [ { "name": "fdns", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/shelves/{shelfFdn}": { "get": { "tags": [ "Shelves" ], "operationId": "getShelfUsingGET", "description": "The parameters and request body are for method: getShelfUsingGET. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "shelfFdn", "in": "path", "required": true, "schema": { "title": "shelfFdn", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } } }, "components": { "schemas": {} } }