openapi: 3.0.0
info:
  title: Network Supervision REST APIs
  description: "The Network Supervision application allows users to monitor the health of objects, such as NEs, card slots, cards, ports, links or link aggregation groups, using KPIs, and monitor the fault status of a network. <br /><br />The objects returned are coming from all deployed source systems.<br /><br /><p><b>Access Information</b></p><p>Prior to accessing the API services below, the API client must authenticate the NSP user via the NSP REST Gateway's authentication API service. The api-docs for the REST Gateway can be found with the NSP Product at: </p><p>https://&#60;server&#62;/rest-gateway/api-docs/  - where &#60;server&#62; is the hostname or IP address of the installed NSP server</p><p>or via the NSP DevPortal at: </p><p><a href='https://nsp.developer.nokia.com/api-documentation/'>https://nsp.developer.nokia.com/api-documentation/</a> - you will need to create an account on the NSP DevPortal to gain access to the api-docs</p>"
  contact: {}
  version: '1.0'
servers:
- url: https://147.75.202.66:8544/NetworkSupervision/rest/api
  variables: {}
paths:
  /v1/cardSlots:
    get:
      tags:
      - cardSlots
      summary: getCardSlotsUsingGET
      description: "Returns a paged list of specific card slots. The size of each page is determined by the 'limit' query parameter. The list will contain the FDN of each resulting card slot. Each card slot contains a link to the installed card, if not empty. Not providing a filter will return all card slots.<br /><br /><strong>Filterable properties:</strong> <br /><strong>sourceType:</strong> The type of the source system. For example: <i>nfmp</i> <br /><strong>sourceSystem:</strong> The partial FDN identifying the source system. For example: <i>fdn:realm:sam</i> <br /><strong>name:</strong> The user friendly visible name <br /><strong>neName:</strong> The name of the Network Element containing the Card Slot <br /><strong>neId:</strong> The id of the Network Element containing the Card Slot<br /><strong>description:</strong> The detailed description of the Card Slot  <br /><strong>positionId:</strong> The relative position of the Card Slot that determines the order in which to show it in the source system UI<br /><strong>position:</strong> A formatted name that describes the position of the Card Slot within the Network Element<br /><strong>adminState:</strong> The administrative state <br /><strong>operState:</strong> The operational state <br /><strong>standbyState:</strong> The standby state <br /><strong>availabilityStates:</strong> The availability state <br /><strong>stateReasons:</strong> A set of specific reasons why the Card Slot is in this state   <br /><strong>objectDetails:</strong> Generic properties of the Card Slot <br /><strong>manufacturer:</strong> The vendor of the Card Slot <br /><strong>serialNumber:</strong> The serial number of the Card Slot provided by the manufacturer <br /><strong>partNumber:</strong> The part number of the Card Slot provided by the manufacturer <br /><strong>manufacturerAssemblyNumber:</strong> The assembly number of the Card Slot provided by the manufacturer <br /><strong>manufactureDate:</strong> The date of manufacture of the Card Slot <br /><strong>manufacturingDeviations:</strong> The manufacturing deviations of the Card Slot provided by the manufacturer <br /><strong>macAddress:</strong> The base MAC Address of the Card Slot <br /><strong>hwMacAddress:</strong> The Hardware MAC Address of the Card Slot <br /><strong>provisionedType:</strong> The type of Card provisioned in the Card Slot   <br /><strong>actualType:</strong> The type of Card present in the Card Slot <br /><strong>holderState:</strong> The status of the Card Slot <br /><br />Examples:<br />Get all card slots:  GET /v1/cardSlots<br />Get all card slots, using a comma-separated list of FDNs:  GET /v1/cardSlots?fdns=fdn:model:equipment:EquipmentHolder:2127,fdn:model:equipment:EquipmentHolder:2128<br />Get all card slots, with filter by holderState:  GET /v1/cardSlots?filter=holderState%3D'installedAndExpected'<br />Get all card slots, with filter by provisionedType:  GET /v1/cardSlots?filter=NOT%20(provisionedType%20LIKE%20'%25IOM%25')<br />Get all card slots, with filter by combined criteria:  GET /v1/cardSlots?filter=holderState%3D'installedAndExpected'%20AND%20NOT%20(provisionedType%20LIKE%20'%25IOM%25')"
      operationId: getCardSlotsUsingGET
      parameters:
      - name: fdns
        in: query
        description: A comma-separated list of the Fully Distinguished Names of the NSP objects to query for.
        style: form
        explode: true
        schema:
          type: string
      - name: filter
        in: query
        description: "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')"
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: 'The limit on the number of objects returned (max: 1000)'
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 300
      - name: offset
        in: query
        description: 'Start row for paged data (max: total number of objects)'
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      responses:
        '200':
          description: OK - Request executed successfully
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CardSlot'
                description: ''
        '400':
          description: Bad Request - Malformed content or invalid parameter data provided
          headers: {}
          content: {}
        '401':
          description: Unauthorized - Authentication rejected
          headers: {}
          content: {}
        '404':
          description: Not Found - URL or resource does not exist
          headers: {}
          content: {}
        '405':
          description: Method Not Allowed - HTTP method not allowed for this endpoint
          headers: {}
          content: {}
        '500':
          description: Internal Server Error - Server error
          headers: {}
          content: {}
      deprecated: false
      security:
      - RESTToken:
        - global
  /v1/cardSlots/{cardSlotFdn}:
    get:
      tags:
      - cardSlots
      summary: getCardSlotUsingGET
      description: Returns detailed information for the specified card slot, which contains a link to the installed card, if not empty.<br /><br />Example:<br />GET /v1/cardSlots/fdn:model:equipment:EquipmentHolder:2127
      operationId: getCardSlotUsingGET
      parameters:
      - name: cardSlotFdn
        in: path
        description: cardSlotFdn
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK - Request executed successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CardSlot'
        '400':
          description: Bad Request - Malformed content or invalid parameter data provided
          headers: {}
          content: {}
        '401':
          description: Unauthorized - Authentication rejected
          headers: {}
          content: {}
        '403':
          description: Forbidden - No user access to the resource
          headers: {}
          content: {}
        '404':
          description: Not Found - URL or resource does not exist
          headers: {}
          content: {}
        '405':
          description: Method Not Allowed - HTTP method not allowed for this endpoint
          headers: {}
          content: {}
        '422':
          description: Unprocessable Entity - Invalid FDN provided
          headers: {}
          content: {}
        '500':
          description: Internal Server Error - Server error
          headers: {}
          content: {}
      deprecated: false
      security:
      - RESTToken:
        - global
  /v1/cards:
    get:
      tags:
      - cards
      summary: getCardsUsingGET
      description: "Returns a paged list of specific cards. The size of each page is determined by the 'limit' query parameter. The list will contain the FDN of each resulting card. Not providing a filter will return all cards.<br /><br /><strong>Filterable properties:</strong> <br /><strong>sourceType:</strong> The type of the source system. For example: <i>nfmp</i> <br /><strong>sourceSystem:</strong> The partial FDN identifying the source system. For example: <i>fdn:realm:sam</i> <br /><strong>name:</strong> The user friendly visible name <br /><strong>neName:</strong> The name of the Network Element containing the Card <br /><strong>neId:</strong> The id of the Network Element containing the Card <br /><strong>description:</strong> The detailed description of the Card  <br /><strong>positionId:</strong> The relative position of the Card that determines the order in which to show it in the source system UI<br /><strong>position:</strong> A formatted name that describes the position of the Card within the Network Element<br /><strong>adminState:</strong> The administrative state <br /><strong>operState:</strong> The operational state <br /><strong>standbyState:</strong> The standby state <br /><strong>availabilityStates:</strong> The availability state <br /><strong>stateReasons:</strong> A set of specific reasons why the Card is in this state   <br /><strong>objectDetails:</strong> Generic properties of the Card  <br /><strong>manufacturer:</strong> The vendor of the Card <br /><strong>serialNumber:</strong> The serial number of the Card provided by the manufacturer <br /><strong>partNumber:</strong> The part number of the Card provided by the manufacturer <br /><strong>manufacturerAssemblyNumber:</strong> The assembly number of the Card provided by the manufacturer <br /><strong>manufactureDate:</strong> The date of manufacture of the Card  <br /><strong>manufacturingDeviations:</strong> The manufacturing deviations of the Card provided by the manufacturer <br /><strong>macAddress:</strong> The base MAC Address of the Card <br /><strong>hwMacAddress:</strong> The Hardware MAC Address of the Card  <br /><br />Examples:<br />Get all cards:  GET /v1/cards<br />Get all cards, using a comma-separated list of FDNs:  GET /v1/cards?fdns=fdn:model:equipment:Equipment:2184,fdn:model:equipment:Equipment:2186<br />Get all cards, with filter by manufacturerAssemblyNumber:  GET /v1/cards?filter=manufacturerAssemblyNumber%20LIKE%20'%252345%25'<br />Get all cards, with filter by partNumber:  GET /v1/cards?filter=partNumber%3D'c18e522906354010bb21e4b78b2ca014'<br />Get all cards, with filter by combined criteria:  GET /v1/cards?filter=manufacturerAssemblyNumber%20LIKE%20'%252345%25'%20AND%20partNumber%3D'c18e522906354010bb21e4b78b2ca014'"
      operationId: getCardsUsingGET
      parameters:
      - name: fdns
        in: query
        description: A comma-separated list of the Fully Distinguished Names of the NSP objects to query for.
        style: form
        explode: true
        schema:
          type: string
      - name: filter
        in: query
        description: "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')"
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: 'The limit on the number of objects returned (max: 1000)'
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 300
      - name: offset
        in: query
        description: 'Start row for paged data (max: total number of objects)'
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      responses:
        '200':
          description: OK - Request executed successfully
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Card'
                description: ''
        '400':
          description: Bad Request - Malformed content or invalid parameter data provided
          headers: {}
          content: {}
        '401':
          description: Unauthorized - Authentication rejected
          headers: {}
          content: {}
        '404':
          description: Not Found - URL or resource does not exist
          headers: {}
          content: {}
        '405':
          description: Method Not Allowed - HTTP method not allowed for this endpoint
          headers: {}
          content: {}
        '500':
          description: Internal Server Error - Server error
          headers: {}
          content: {}
      deprecated: false
      security:
      - RESTToken:
        - global
  /v1/cards/{cardFdn}:
    get:
      tags:
      - cards
      summary: getCardUsingGET
      description: Returns detailed information for the specified card.<br /><br />Example:<br />GET /v1/cards/fdn:model:equipment:Equipment:2184
      operationId: getCardUsingGET
      parameters:
      - name: cardFdn
        in: path
        description: cardFdn
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK - Request executed successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Card'
        '400':
          description: Bad Request - Malformed content or invalid parameter data provided
          headers: {}
          content: {}
        '401':
          description: Unauthorized - Authentication rejected
          headers: {}
          content: {}
        '403':
          description: Forbidden - No user access to the resource
          headers: {}
          content: {}
        '404':
          description: Not Found - URL or resource does not exist
          headers: {}
          content: {}
        '405':
          description: Method Not Allowed - HTTP method not allowed for this endpoint
          headers: {}
          content: {}
        '422':
          description: Unprocessable Entity - Invalid FDN provided
          headers: {}
          content: {}
        '500':
          description: Internal Server Error - Server error
          headers: {}
          content: {}
      deprecated: false
      security:
      - RESTToken:
        - global
  /v1/lags:
    get:
      tags:
      - lags
      summary: getLAGsUsingGET
      description: "Returns a paged list of specific LAGs. The size of each page is determined by the 'limit' query parameter. The list will contain the FDN of each resulting LAG. Not providing a filter will return all LAGs.<br /><br /><strong>Filterable properties:</strong> <br /><strong>sourceType:</strong> The type of the source system. For example: <i>nfmp</i> <br /><strong>sourceSystem:</strong> The partial FDN identifying the source system. For example: <i>fdn:realm:sam</i> <br /><strong>name:</strong> The user friendly visible name <br /><strong>neName:</strong> The name of this LAG <br /><strong>neId:</strong> The id of this LAG<br /><strong>description:</strong> The detailed description of this LAG <br /><strong>configuredAddress:</strong> The MAC Address of this LAG <br /><strong>encapType:</strong> The encapsulation type of this LAG <br /><strong>operationalSpeedUnits:</strong> The units associated to the ‘operationalSpeed’ field value for this LAG<br /><strong>operationalSpeed:</strong> The total operational speed of this LAG, in units specified by the ‘operationalSpeedUnits’ field value<br /><strong>adminState:</strong> The administrative state <br /><strong>operState:</strong> The operational state <br /><strong>standbyState:</strong> The standby state <br /><strong>availabilityStates:</strong> The availability state <br /><strong>stateReasons:</strong> A set of specific reasons why the LAG is in this state   <br /><strong>objectDetails:</strong> Generic properties of this LAG <br /><br />Examples:<br />Get all LAGs:  GET /v1/lags<br />Get all LAGs, using a comma-separated list of FDNs:  GET /v1/lags?fdns=fdn:model:equipment:LAG:12872,fdn:model:equipment:LAG:12873<br />Get all LAGs, with filter by configuredAddress:  GET /v1/lags?filter=configuredAddress%20LIKE%20'C0-3E%25'<br />Get all LAGs, with filter by neId:  GET /v1/lags?filter=neId%20LIKE%20'%25.85'<br />Get all LAGs, with filter by combined criteria:  GET /v1/lags?filter=NOT%20(configuredAddress%20LIKE%20'C0-3E%25')%20AND%20neId%20LIKE%20'%25.85'"
      operationId: getLAGsUsingGET
      parameters:
      - name: fdns
        in: query
        description: A comma-separated list of the Fully Distinguished Names of the NSP objects to query for.
        style: form
        explode: true
        schema:
          type: string
      - name: filter
        in: query
        description: "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')"
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: 'The limit on the number of objects returned (max: 1000)'
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 300
      - name: offset
        in: query
        description: 'Start row for paged data (max: total number of objects)'
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      responses:
        '200':
          description: OK - Request executed successfully
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LAG'
                description: ''
        '400':
          description: Bad Request - Malformed content or invalid parameter data provided
          headers: {}
          content: {}
        '401':
          description: Unauthorized - Authentication rejected
          headers: {}
          content: {}
        '404':
          description: Not Found - URL or resource does not exist
          headers: {}
          content: {}
        '405':
          description: Method Not Allowed - HTTP method not allowed for this endpoint
          headers: {}
          content: {}
        '500':
          description: Internal Server Error - Server error
          headers: {}
          content: {}
      deprecated: false
      security:
      - RESTToken:
        - global
  /v1/lags/{lagFdn}:
    get:
      tags:
      - lags
      summary: getLAGUsingGET
      description: Returns detailed information for the specified LAG.<br /><br />Example:<br />GET /v1/lags/fdn:model:equipment:LAG:12872
      operationId: getLAGUsingGET
      parameters:
      - name: lagFdn
        in: path
        description: lagFdn
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK - Request executed successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LAG'
        '400':
          description: Bad Request - Malformed content or invalid parameter data provided
          headers: {}
          content: {}
        '401':
          description: Unauthorized - Authentication rejected
          headers: {}
          content: {}
        '403':
          description: Forbidden - No user access to the resource
          headers: {}
          content: {}
        '404':
          description: Not Found - URL or resource does not exist
          headers: {}
          content: {}
        '405':
          description: Method Not Allowed - HTTP method not allowed for this endpoint
          headers: {}
          content: {}
        '422':
          description: Unprocessable Entity - Invalid FDN provided
          headers: {}
          content: {}
        '500':
          description: Internal Server Error - Server error
          headers: {}
          content: {}
      deprecated: false
      security:
      - RESTToken:
        - global
  /v1/networkElements:
    get:
      tags:
      - networkElements
      summary: getNEsUsingGET
      description: "Returns a paged list of specific network elements. The size of each page is determined by the 'limit' query parameter. The list will contain the FDN of each resulting network element. Not providing a filter will return all network elements.<br /><br /><strong>Filterable properties:</strong> <br /><strong>sourceType:</strong> The type of the source system. For example: <i>nfmp</i> <br /><strong>sourceSystem:</strong> The partial FDN identifying the source system. For example: <i>fdn:realm:sam</i> <br /><strong>name:</strong> The name of this Network Element, as defined by the source system <br /><strong>neName:</strong> The name of the Network Element which is unique within the source system<br /><strong>neId:</strong> The id of the Network Element <br /><strong>description:</strong> The detailed description of the Network Element <br /><strong>ipAddress:</strong> The management IP address of the Network Element <br /><strong>type:</strong> The type of the Network Element <br /><strong>product:</strong> The vendor product name of the Network Element <br /><strong>version:</strong> The version of the Network Element <br /><strong>resyncState:</strong> The resynchronization status of the Network Element <br /><strong>longitude:</strong> The longitude (in degrees) of the Network Element, if known. Min = -180, Max = 180 <br /><strong>latitude:</strong> The latitude (in degrees) of the Network Element, if known. Min = -90, Max = 90 <br /><strong>location:</strong> The location of the Network Element <br /><strong>topologyGroup:</strong> The Fully Distinguished Name of the topology group that the Network Element belongs to, if any <br /><strong>adminState:</strong> The administrative state <br /><strong>operState:</strong> The operational state <br /><strong>standbyState:</strong> The standby state <br /><strong>availabilityStates:</strong> The availability state <br /><strong>objectDetails:</strong> Generic properties of the Network Element <br /><strong>networkType:</strong> The type of network the Network Element is part of <br /><strong>communicationState:</strong> The communication status of the Network Element <br /><strong>communicationStateDetails:</strong> The reachability status of each supported management protocol of the Network Element <br /><strong>macAddress:</strong> The Mac address of the Network Element <br /><strong>clliCode:</strong> Common Language Location Identifier (CLLI) code value for the system <br /><br />Examples:<br />Get all network elements:  GET /v1/networkElements<br />Get all network elements, using a comma-separated list of FDNs:  GET /v1/networkElements?fdns=fdn:model:equipment:NetworkElement:2102,fdn:model:equipment:NetworkElement:2103<br />Get all network elements, with filter by managedState:  GET /v1/networkElements?filter=managedState%3D'managed'<br />Get all network elements, with filter by product:  GET /v1/networkElements?filter=product%20LIKE%20'7750%25'<br />Get all network elements, with filter by combined criteria:  GET /v1/networkElements?filter=managedState%3D'managed'%20AND%20NOT%20(product%20LIKE%20'7750%25')"
      operationId: getNEsUsingGET
      parameters:
      - name: fdns
        in: query
        description: A comma-separated list of the Fully Distinguished Names of the NSP objects to query for.
        style: form
        explode: true
        schema:
          type: string
      - name: filter
        in: query
        description: "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')"
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: 'The limit on the number of objects returned (max: 1000)'
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 300
      - name: offset
        in: query
        description: 'Start row for paged data (max: total number of objects)'
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      responses:
        '200':
          description: OK - Request executed successfully
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/NetworkElement'
                description: ''
        '400':
          description: Bad Request - Malformed content or invalid parameter data provided
          headers: {}
          content: {}
        '401':
          description: Unauthorized - Authentication rejected
          headers: {}
          content: {}
        '404':
          description: Not Found - URL or resource does not exist
          headers: {}
          content: {}
        '405':
          description: Method Not Allowed - HTTP method not allowed for this endpoint
          headers: {}
          content: {}
        '500':
          description: Internal Server Error - Server error
          headers: {}
          content: {}
      deprecated: false
      security:
      - RESTToken:
        - global
  /v1/networkElements/{networkElementFdn}:
    get:
      tags:
      - networkElements
      summary: getNEUsingGET
      description: Returns detailed information for the specified network element.<br /><br />Example:<br />GET /v1/networkElements/fdn:model:equipment:NetworkElement:2102
      operationId: getNEUsingGET
      parameters:
      - name: networkElementFdn
        in: path
        description: networkElementFdn
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK - Request executed successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkElement'
        '400':
          description: Bad Request - Malformed content or invalid parameter data provided
          headers: {}
          content: {}
        '401':
          description: Unauthorized - Authentication rejected
          headers: {}
          content: {}
        '403':
          description: Forbidden - No user access to the resource
          headers: {}
          content: {}
        '404':
          description: Not Found - URL or resource does not exist
          headers: {}
          content: {}
        '405':
          description: Method Not Allowed - HTTP method not allowed for this endpoint
          headers: {}
          content: {}
        '422':
          description: Unprocessable Entity - Invalid FDN provided
          headers: {}
          content: {}
        '500':
          description: Internal Server Error - Server error
          headers: {}
          content: {}
      deprecated: false
      security:
      - RESTToken:
        - global
  /v1/networkElements/{networkElementFdn}/lags:
    get:
      tags:
      - networkElements
      summary: getNELAGsUsingGET
      description: 'Returns a list of specific LAGs. The list will contain the FDN of each resulting LAG. Not providing a filter will return all LAGs.<br /><br /><strong>Filterable properties:</strong> <br /><strong>sourceType:</strong> The type of the source system. For example: <i>nfmp</i> <br /><strong>sourceSystem:</strong> The partial FDN identifying the source system. For example: <i>fdn:realm:sam</i> <br /><strong>name:</strong> The name of the LAG, as defined by the source system <br /><strong>neName:</strong> The name of the LAG which is unique within the source system<br /><strong>neId:</strong> The id of the LAG <br /><strong>description:</strong> The detailed description of the LAG <br /><strong>configuredAddress:</strong> The MAC Address of the LAG <br /><strong>encapType:</strong> The encapsulation type of the LAG <br /><strong>operationalSpeedUnits:</strong> The units associated to the ‘operationalSpeed’ field value for the LAG<br /><strong>operationalSpeed:</strong> The total operational speed of the LAG, in units specified by the ‘operationalSpeedUnits’ field value<br /><strong>adminState:</strong> The administrative state <br /><strong>operState:</strong> The operational state <br /><strong>standbyState:</strong> The standby state <br /><strong>availabilityStates:</strong> The availability state <br /><strong>objectDetails:</strong> Generic properties of the LAG <br /><br />Examples:<br />'
      operationId: getNELAGsUsingGET
      parameters:
      - name: filter
        in: query
        description: "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')"
        style: form
        explode: true
        schema:
          type: string
      - name: networkElementFdn
        in: path
        description: networkElementFdn
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK - Request executed successfully
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LAG'
                description: ''
        '400':
          description: Bad Request - Malformed content or invalid parameter data provided
          headers: {}
          content: {}
        '401':
          description: Unauthorized - Authentication rejected
          headers: {}
          content: {}
        '403':
          description: Forbidden - No user access to the resource
          headers: {}
          content: {}
        '404':
          description: Not Found - URL or resource does not exist
          headers: {}
          content: {}
        '405':
          description: Method Not Allowed - HTTP method not allowed for this endpoint
          headers: {}
          content: {}
        '422':
          description: Unprocessable Entity - Invalid FDN provided
          headers: {}
          content: {}
        '500':
          description: Internal Server Error - Server error
          headers: {}
          content: {}
      deprecated: false
      security:
      - RESTToken:
        - global
  /v1/networkElements/{networkElementFdn}/lags/{lagFdn}/lagMembers:
    get:
      tags:
      - networkElements
      summary: getLagMembersUsingGET
      description: Returns a list of specific LAG members. The list will contain the FDN of each resulting LAG member. Not providing a filter will return all LAG members.<br /><br />Examples:<br />
      operationId: getLagMembersUsingGET
      parameters:
      - name: filter
        in: query
        description: "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')"
        style: form
        explode: true
        schema:
          type: string
      - name: lagFdn
        in: path
        description: lagFdn
        required: true
        style: simple
        schema:
          type: string
      - name: networkElementFdn
        in: path
        description: networkElementFdn
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK - Request executed successfully
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LAGMemberDetails'
                description: ''
        '400':
          description: Bad Request - Malformed content or invalid parameter data provided
          headers: {}
          content: {}
        '401':
          description: Unauthorized - Authentication rejected
          headers: {}
          content: {}
        '403':
          description: Forbidden - No user access to the resource
          headers: {}
          content: {}
        '404':
          description: Not Found - URL or resource does not exist
          headers: {}
          content: {}
        '405':
          description: Method Not Allowed - HTTP method not allowed for this endpoint
          headers: {}
          content: {}
        '422':
          description: Unprocessable Entity - Invalid FDN provided
          headers: {}
          content: {}
        '500':
          description: Internal Server Error - Server error
          headers: {}
          content: {}
      deprecated: false
      security:
      - RESTToken:
        - global
  /v1/networkElements/{networkElementFdn}/radioEquipment:
    get:
      tags:
      - networkElements
      summary: getNERadioEquipmentsUsingGET
      description: 'Returns a list of specific radio equipments. The list will contain the FDN of each resulting Radio Equipment. Not providing a filter will return all Radio Equipments.<br /><br /><strong>Filterable properties:</strong> <br /><strong>sourceType:</strong> The type of the source system. For example: <i>nfmp</i> <br /><strong>sourceSystem:</strong> The partial FDN identifying the source system. For example: <i>fdn:realm:sam</i> <br /><strong>name:</strong> The name of the radio equipment, as defined by the source system <br /><strong>neName:</strong> The name of the radio equipment which is unique within the source system<br /><strong>neId:</strong> The id of the radio equipment <br /><strong>description:</strong> The detailed description of the radio equipment <br /><strong>ipAddress:</strong> The management IP address of the radio equipment <br /><strong>product:</strong> The vendor product name of the radio equipment <br /><strong>version:</strong> The version of this radio equipment <br /><strong>longitude:</strong> The longitude (in degrees) of the radio equipment, if known. Min = -180, Max = 180 <br /><strong>latitude:</strong> The latitude (in degrees) of the radio equipment, if known. Min = -90, Max = 90 <br /><strong>location:</strong> The location of the radio equipment <br /><strong>adminState:</strong> The administrative state <br /><strong>operState:</strong> The operational state <br /><strong>standbyState:</strong> The standby state <br /><strong>communicationState:</strong> The communication status of the radio equipment <br /><strong>availabilityStates:</strong> The availability state <br /><strong>objectDetails:</strong> Generic properties of the radio equipment <br /><strong>macAddress:</strong> The Mac address of the radio equipment <br /><strong>clliCode:</strong> Common Language Location Identifier (CLLI) code value for the system <br /><br />Examples:<br />'
      operationId: getNERadioEquipmentsUsingGET
      parameters:
      - name: filter
        in: query
        description: "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')"
        style: form
        explode: true
        schema:
          type: string
      - name: networkElementFdn
        in: path
        description: networkElementFdn
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK - Request executed successfully
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RadioEquipment'
                description: ''
        '400':
          description: Bad Request - Malformed content or invalid parameter data provided
          headers: {}
          content: {}
        '401':
          description: Unauthorized - Authentication rejected
          headers: {}
          content: {}
        '403':
          description: Forbidden - No user access to the resource
          headers: {}
          content: {}
        '404':
          description: Not Found - URL or resource does not exist
          headers: {}
          content: {}
        '405':
          description: Method Not Allowed - HTTP method not allowed for this endpoint
          headers: {}
          content: {}
        '422':
          description: Unprocessable Entity - Invalid FDN provided
          headers: {}
          content: {}
        '500':
          description: Internal Server Error - Server error
          headers: {}
          content: {}
      deprecated: false
      security:
      - RESTToken:
        - global
  /v1/networkElements/{networkElementFdn}/radioEquipment/{radioEquipmentFdn}/lags:
    get:
      tags:
      - networkElements
      summary: getRadioEquipmentLagsUsingGET
      description: 'Returns a list of specific LAGs on a radio equipment linked to a network element. The list will contain the FDN of each resulting LAG. Not providing a filter will return all LAGs.<br /><br /><strong>Filterable properties:</strong> <br /><strong>sourceType:</strong> The type of the source system. For example: <i>nfmp</i> <br /><strong>sourceSystem:</strong> The partial FDN identifying the source system. For example: <i>fdn:realm:sam</i> <br /><strong>name:</strong> The user friendly visible name <br /><strong>neName:</strong> The name of the LAG <br /><strong>neId:</strong> The id of the LAG<br /><strong>description:</strong> The detailed description of the LAG <br /><strong>configuredAddress:</strong> The MAC Address of the LAG <br /><strong>encapType:</strong> The encapsulation type of the LAG <br /><strong>operationalSpeedUnits:</strong> The units associated to the ‘operationalSpeed’ field value for the LAG<br /><strong>operationalSpeed:</strong> The total operational speed of the LAG, in units specified by the ‘operationalSpeedUnits’ field value<br /><strong>adminState:</strong> The administrative state <br /><strong>operState:</strong> The operational state <br /><strong>standbyState:</strong> The standby state <br /><strong>availabilityStates:</strong> The availability state <br /><strong>stateReasons:</strong> A set of specific reasons why the LAG is in this state   <br /><strong>objectDetails:</strong> Generic properties of the LAG <br /><br />Examples:<br />'
      operationId: getRadioEquipmentLagsUsingGET
      parameters:
      - name: filter
        in: query
        description: "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')"
        style: form
        explode: true
        schema:
          type: string
      - name: networkElementFdn
        in: path
        description: networkElementFdn
        required: true
        style: simple
        schema:
          type: string
      - name: radioEquipmentFdn
        in: path
        description: radioEquipmentFdn
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK - Request executed successfully
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LAG'
                description: ''
        '400':
          description: Bad Request - Malformed content or invalid parameter data provided
          headers: {}
          content: {}
        '401':
          description: Unauthorized - Authentication rejected
          headers: {}
          content: {}
        '403':
          description: Forbidden - No user access to the resource
          headers: {}
          content: {}
        '404':
          description: Not Found - URL or resource does not exist
          headers: {}
          content: {}
        '405':
          description: Method Not Allowed - HTTP method not allowed for this endpoint
          headers: {}
          content: {}
        '422':
          description: Unprocessable Entity - Invalid FDN provided
          headers: {}
          content: {}
        '500':
          description: Internal Server Error - Server error
          headers: {}
          content: {}
      deprecated: false
      security:
      - RESTToken:
        - global
  /v1/networkElements/{networkElementFdn}/radioEquipment/{radioEquipmentFdn}/lags/{lagFdn}/lagMembers:
    get:
      tags:
      - networkElements
      summary: getRadioEquipmentLagMembersUsingGET
      description: Returns a list of specific LAG members a radio equipment LAG. The list will contain the FDN of each resulting LAG member. Not providing a filter will return all LAG members.<br /><br />Examples:<br />
      operationId: getRadioEquipmentLagMembersUsingGET
      parameters:
      - name: filter
        in: query
        description: "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')"
        style: form
        explode: true
        schema:
          type: string
      - name: lagFdn
        in: path
        description: lagFdn
        required: true
        style: simple
        schema:
          type: string
      - name: networkElementFdn
        in: path
        description: networkElementFdn
        required: true
        style: simple
        schema:
          type: string
      - name: radioEquipmentFdn
        in: path
        description: radioEquipmentFdn
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK - Request executed successfully
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LAGMemberDetails'
                description: ''
        '400':
          description: Bad Request - Malformed content or invalid parameter data provided
          headers: {}
          content: {}
        '401':
          description: Unauthorized - Authentication rejected
          headers: {}
          content: {}
        '403':
          description: Forbidden - No user access to the resource
          headers: {}
          content: {}
        '404':
          description: Not Found - URL or resource does not exist
          headers: {}
          content: {}
        '405':
          description: Method Not Allowed - HTTP method not allowed for this endpoint
          headers: {}
          content: {}
        '422':
          description: Unprocessable Entity - Invalid FDN provided
          headers: {}
          content: {}
        '500':
          description: Internal Server Error - Server error
          headers: {}
          content: {}
      deprecated: false
      security:
      - RESTToken:
        - global
  /v1/networkElements/{networkElementFdn}/radioEquipment/{radioEquipmentFdn}/shelves:
    get:
      tags:
      - networkElements
      summary: getRadioEquipmentShelvesUsingGET
      description: 'Returns a list of specific shelves on a radio equipment linked to a network element. The list will contain the FDN of each resulting shelf. Not providing a filter will return all shelves.<br /><br /><strong>Filterable properties:</strong> <br /><strong>sourceType:</strong> The type of the source system. For example: <i>nfmp</i> <br /><strong>sourceSystem:</strong> The partial FDN identifying the source system. For example: <i>fdn:realm:sam</i> <br /><strong>name:</strong> The user friendly visible name <br /><strong>neName:</strong> The name of the radio equipment containing the Shelf <br /><strong>neId:</strong> The id of the radio equipment containing the Shelf <br /><strong>description:</strong> The detailed description of the Shelf  <br /><strong>positionId:</strong> The relative position of the Shelf that determines the order in which to show it in the source system UI<br /><strong>position:</strong> A formatted name that describes the position of the Shelf within the radio equipment<br /><strong>adminState:</strong> The administrative state <br /><strong>operState:</strong> The operational state <br /><strong>standbyState:</strong> The standby state <br /><strong>availabilityStates:</strong> The availability state <br /><strong>stateReasons:</strong> A set of specific reasons why the Shelf is in this state   <br /><strong>objectDetails:</strong> Generic properties of this Shelf <br /><strong>manufacturer:</strong> The vendor of the Shelf <br /><strong>serialNumber:</strong> The serial number of the Shelf provided by the manufacturer <br /><strong>partNumber:</strong> The part number of the Shelf provided by the manufacturer <br /><strong>manufacturerAssemblyNumber:</strong> The assembly number of the Shelf provided by the manufacturer <br /><strong>manufactureDate:</strong> The date of manufacture of the Shelf <br /><strong>manufacturingDeviations:</strong> The manufacturing deviations of the Shelf provided by the manufacturer <br /><strong>macAddress:</strong> The base MAC Address of the Shelf <br /><strong>hwMacAddress:</strong> The Hardware MAC Address of the Shelf <br /><br />Examples:<br />'
      operationId: getRadioEquipmentShelvesUsingGET
      parameters:
      - name: filter
        in: query
        description: "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')"
        style: form
        explode: true
        schema:
          type: string
      - name: networkElementFdn
        in: path
        description: networkElementFdn
        required: true
        style: simple
        schema:
          type: string
      - name: radioEquipmentFdn
        in: path
        description: radioEquipmentFdn
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK - Request executed successfully
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Shelf'
                description: ''
        '400':
          description: Bad Request - Malformed content or invalid parameter data provided
          headers: {}
          content: {}
        '401':
          description: Unauthorized - Authentication rejected
          headers: {}
          content: {}
        '403':
          description: Forbidden - No user access to the resource
          headers: {}
          content: {}
        '404':
          description: Not Found - URL or resource does not exist
          headers: {}
          content: {}
        '405':
          description: Method Not Allowed - HTTP method not allowed for this endpoint
          headers: {}
          content: {}
        '422':
          description: Unprocessable Entity - Invalid FDN provided
          headers: {}
          content: {}
        '500':
          description: Internal Server Error - Server error
          headers: {}
          content: {}
      deprecated: false
      security:
      - RESTToken:
        - global
  /v1/networkElements/{networkElementFdn}/radioEquipment/{radioEquipmentFdn}/shelves/{shelfFdn}/cards:
    get:
      tags:
      - networkElements
      summary: getRadioEquipmentShelfCardsUsingGET
      description: 'Returns a list of specific cards on a radio equipment shelf. The list will contain the FDN of each resulting card. Not providing a filter will return all cards.<br /><br /><strong>Filterable properties:</strong> <br /><strong>sourceType:</strong> The type of the source system. For example: <i>nfmp</i> <br /><strong>sourceSystem:</strong> The partial FDN identifying the source system. For example: <i>fdn:realm:sam</i> <br /><strong>name:</strong> The user friendly visible name <br /><strong>neName:</strong> The name of the Network Element containing the Card <br /><strong>neId:</strong> The id of the Network Element containing the Card <br /><strong>description:</strong> The detailed description of the Card  <br /><strong>positionId:</strong> The relative position of the Card that determines the order in which to show it in the source system UI<br /><strong>position:</strong> A formatted name that describes the position of the Card within the Network Element<br /><strong>adminState:</strong> The administrative state <br /><strong>operState:</strong> The operational state <br /><strong>standbyState:</strong> The standby state <br /><strong>availabilityStates:</strong> The availability state <br /><strong>stateReasons:</strong> A set of specific reasons why the Card is in this state   <br /><strong>objectDetails:</strong> Generic properties of this Card  <br /><strong>manufacturer:</strong> The vendor of the Card <br /><strong>serialNumber:</strong> The serial number of the Card provided by the manufacturer <br /><strong>partNumber:</strong> The part number of the Card provided by the manufacturer <br /><strong>manufacturerAssemblyNumber:</strong> The assembly number of the Card provided by the manufacturer <br /><strong>manufactureDate:</strong> The date of manufacture of the Card  <br /><strong>manufacturingDeviations:</strong> The manufacturing deviations of the Card provided by the manufacturer <br /><strong>macAddress:</strong> The base MAC Address of the Card <br /><strong>hwMacAddress:</strong> The Hardware MAC Address of the Card  <br /><br />Examples:<br />'
      operationId: getRadioEquipmentShelfCardsUsingGET
      parameters:
      - name: filter
        in: query
        description: "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')"
        style: form
        explode: true
        schema:
          type: string
      - name: networkElementFdn
        in: path
        description: networkElementFdn
        required: true
        style: simple
        schema:
          type: string
      - name: radioEquipmentFdn
        in: path
        description: radioEquipmentFdn
        required: true
        style: simple
        schema:
          type: string
      - name: shelfFdn
        in: path
        description: shelfFdn
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK - Request executed successfully
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Card'
                description: ''
        '400':
          description: Bad Request - Malformed content or invalid parameter data provided
          headers: {}
          content: {}
        '401':
          description: Unauthorized - Authentication rejected
          headers: {}
          content: {}
        '403':
          description: Forbidden - No user access to the resource
          headers: {}
          content: {}
        '404':
          description: Not Found - URL or resource does not exist
          headers: {}
          content: {}
        '405':
          description: Method Not Allowed - HTTP method not allowed for this endpoint
          headers: {}
          content: {}
        '422':
          description: Unprocessable Entity - Invalid FDN provided
          headers: {}
          content: {}
        '500':
          description: Internal Server Error - Server error
          headers: {}
          content: {}
      deprecated: false
      security:
      - RESTToken:
        - global
  /v1/networkElements/{networkElementFdn}/radioEquipment/{radioEquipmentFdn}/shelves/{shelfFdn}/cards/{cardFdn}/ports:
    get:
      tags:
      - networkElements
      summary: getRadioEquipmentCardPortsUsingGET
      description: 'Returns a list of specific ports on a radio equipment card. The list will contain the FDN of each resulting port. Not providing a filter will return all ports.<br /><br /><strong>Filterable properties:</strong> <br /><strong>sourceType:</strong> The type of the source system. For example: <i>nfmp</i> <br /><strong>sourceSystem:</strong> The partial FDN identifying the source system. For example: <i>fdn:realm:sam</i> <br /><strong>name:</strong> The user friendly visible name <br /><strong>neName:</strong> The name of the Network Element containing the Port <br /><strong>neId:</strong> The id of the Network Element containing the Port <br /><strong>description:</strong> The detailed description of the Port  <br /><strong>positionId:</strong> The relative position of the Port that determines the order in which to show it in the source system UI<br /><strong>position:</strong> A formatted name that describes the position of the Port within the Network Element<br /><strong>adminState:</strong> The administrative state <br /><strong>operState:</strong> The operational state <br /><strong>standbyState:</strong> The standby state <br /><strong>availabilityStates:</strong> The availability state <br /><strong>stateReasons:</strong> A set of specific reasons why the Port is in this state   <br /><strong>objectDetails:</strong> Generic properties of this Port <br /><strong>manufacturer:</strong> The vendor of the Port <br /><strong>serialNumber:</strong> The serial number of the Port provided by the manufacturer <br /><strong>partNumber:</strong> The part number of the Port provided by the manufacturer <br /><strong>manufacturerAssemblyNumber:</strong> The assembly number of the Port provided by the manufacturer <br /><strong>manufactureDate:</strong> The date of manufacture of the Port <br /><strong>manufacturingDeviations:</strong> The manufacturing deviations of the Port provided by the manufacturer <br /><strong>macAddress:</strong> The base MAC Address of the Port <br /><strong>hwMacAddress:</strong> The Hardware MAC Address of the Port <br /><br />Examples:<br />'
      operationId: getRadioEquipmentCardPortsUsingGET
      parameters:
      - name: cardFdn
        in: path
        description: cardFdn
        required: true
        style: simple
        schema:
          type: string
      - name: filter
        in: query
        description: "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')"
        style: form
        explode: true
        schema:
          type: string
      - name: networkElementFdn
        in: path
        description: networkElementFdn
        required: true
        style: simple
        schema:
          type: string
      - name: radioEquipmentFdn
        in: path
        description: radioEquipmentFdn
        required: true
        style: simple
        schema:
          type: string
      - name: shelfFdn
        in: path
        description: shelfFdn
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK - Request executed successfully
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Port'
                description: ''
        '400':
          description: Bad Request - Malformed content or invalid parameter data provided
          headers: {}
          content: {}
        '401':
          description: Unauthorized - Authentication rejected
          headers: {}
          content: {}
        '403':
          description: Forbidden - No user access to the resource
          headers: {}
          content: {}
        '404':
          description: Not Found - URL or resource does not exist
          headers: {}
          content: {}
        '405':
          description: Method Not Allowed - HTTP method not allowed for this endpoint
          headers: {}
          content: {}
        '422':
          description: Unprocessable Entity - Invalid FDN provided
          headers: {}
          content: {}
        '500':
          description: Internal Server Error - Server error
          headers: {}
          content: {}
      deprecated: false
      security:
      - RESTToken:
        - global
  /v1/networkElements/{networkElementFdn}/shelves:
    get:
      tags:
      - networkElements
      summary: getNEShelvesUsingGET
      description: 'Returns a list of specific shelves. The list will contain the FDN of each resulting shelf. Not providing a filter will return all shelves.<br /><br /><strong>Filterable properties:</strong> <br /><strong>sourceType:</strong> The type of the source system. For example: <i>nfmp</i> <br /><strong>sourceSystem:</strong> The partial FDN identifying the source system. For example: <i>fdn:realm:sam</i> <br /><strong>name:</strong> The user friendly visible name <br /><strong>neName:</strong> The name of the Network Element containing the Shelf <br /><strong>neId:</strong> The id of the Network Element containing the Shelf <br /><strong>description:</strong> The detailed description of the Shelf  <br /><strong>positionId:</strong> The relative position of the Shelf that determines the order in which to show it in the source system UI<br /><strong>position:</strong> A formatted name that describes the position of the Shelf within the Network Element<br /><strong>adminState:</strong> The administrative state <br /><strong>operState:</strong> The operational state <br /><strong>standbyState:</strong> The standby state <br /><strong>availabilityStates:</strong> The availability state <br /><strong>stateReasons:</strong> A set of specific reasons why the Shelf is in this state   <br /><strong>objectDetails:</strong> Generic properties of this Shelf <br /><strong>manufacturer:</strong> The vendor of the Shelf <br /><strong>serialNumber:</strong> The serial number of the Shelf provided by the manufacturer <br /><strong>partNumber:</strong> The part number of the Shelf provided by the manufacturer <br /><strong>manufacturerAssemblyNumber:</strong> The assembly number of the Shelf provided by the manufacturer <br /><strong>manufactureDate:</strong> The date of manufacture of the Shelf <br /><strong>manufacturingDeviations:</strong> The manufacturing deviations of the Shelf provided by the manufacturer <br /><strong>macAddress:</strong> The base MAC Address of the Shelf <br /><strong>hwMacAddress:</strong> The Hardware MAC Address of the Shelf <br /><br />Examples:<br />'
      operationId: getNEShelvesUsingGET
      parameters:
      - name: filter
        in: query
        description: "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')"
        style: form
        explode: true
        schema:
          type: string
      - name: networkElementFdn
        in: path
        description: networkElementFdn
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK - Request executed successfully
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Shelf'
                description: ''
        '400':
          description: Bad Request - Malformed content or invalid parameter data provided
          headers: {}
          content: {}
        '401':
          description: Unauthorized - Authentication rejected
          headers: {}
          content: {}
        '403':
          description: Forbidden - No user access to the resource
          headers: {}
          content: {}
        '404':
          description: Not Found - URL or resource does not exist
          headers: {}
          content: {}
        '405':
          description: Method Not Allowed - HTTP method not allowed for this endpoint
          headers: {}
          content: {}
        '422':
          description: Unprocessable Entity - Invalid FDN provided
          headers: {}
          content: {}
        '500':
          description: Internal Server Error - Server error
          headers: {}
          content: {}
      deprecated: false
      security:
      - RESTToken:
        - global
  /v1/networkElements/{networkElementFdn}/shelves/{shelfFdn}/cards:
    get:
      tags:
      - networkElements
      summary: getShelfCardsUsingGET
      description: 'Returns a list of specific cards. The list will contain the FDN of each resulting card. Not providing a filter will return all cards.<br /><br /><strong>Filterable properties:</strong> <br /><strong>sourceType:</strong> The type of the source system. For example: <i>nfmp</i> <br /><strong>sourceSystem:</strong> The partial FDN identifying the source system. For example: <i>fdn:realm:sam</i> <br /><strong>name:</strong> The user friendly visible name <br /><strong>neName:</strong> The name of the Network Element containing the Card <br /><strong>neId:</strong> The id of the Network Element containing the Card <br /><strong>description:</strong> The detailed description of the Card  <br /><strong>positionId:</strong> The relative position of the Card that determines the order in which to show it in the source system UI<br /><strong>position:</strong> A formatted name that describes the position of the Card within the Network Element<br /><strong>adminState:</strong> The administrative state <br /><strong>operState:</strong> The operational state <br /><strong>standbyState:</strong> The standby state <br /><strong>availabilityStates:</strong> The availability state <br /><strong>stateReasons:</strong> A set of specific reasons why the Card is in this state   <br /><strong>objectDetails:</strong> Generic properties of the Card <br /><strong>manufacturer:</strong> The vendor of the Card <br /><strong>serialNumber:</strong> The serial number of the Card provided by the manufacturer <br /><strong>partNumber:</strong> The part number of the Card provided by the manufacturer <br /><strong>manufacturerAssemblyNumber:</strong> The assembly number of the Card provided by the manufacturer <br /><strong>manufactureDate:</strong> The date of manufacture of the Card <br /><strong>manufacturingDeviations:</strong> The manufacturing deviations of the Card provided by the manufacturer <br /><strong>macAddress:</strong> The base MAC Address of the Card <br /><strong>hwMacAddress:</strong> The Hardware MAC Address of the Card <br /><br />Examples:<br />'
      operationId: getShelfCardsUsingGET
      parameters:
      - name: filter
        in: query
        description: "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')"
        style: form
        explode: true
        schema:
          type: string
      - name: networkElementFdn
        in: path
        description: networkElementFdn
        required: true
        style: simple
        schema:
          type: string
      - name: shelfFdn
        in: path
        description: shelfFdn
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK - Request executed successfully
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Card'
                description: ''
        '400':
          description: Bad Request - Malformed content or invalid parameter data provided
          headers: {}
          content: {}
        '401':
          description: Unauthorized - Authentication rejected
          headers: {}
          content: {}
        '403':
          description: Forbidden - No user access to the resource
          headers: {}
          content: {}
        '404':
          description: Not Found - URL or resource does not exist
          headers: {}
          content: {}
        '405':
          description: Method Not Allowed - HTTP method not allowed for this endpoint
          headers: {}
          content: {}
        '422':
          description: Unprocessable Entity - Invalid FDN provided
          headers: {}
          content: {}
        '500':
          description: Internal Server Error - Server error
          headers: {}
          content: {}
      deprecated: false
      security:
      - RESTToken:
        - global
  /v1/networkElements/{networkElementFdn}/shelves/{shelfFdn}/cards/{cardFdn}/ports:
    get:
      tags:
      - networkElements
      summary: getCardPortsUsingGET
      description: Returns a list of specific ports. The list will contain the FDN of each resulting port. Not providing a filter will return all ports.<br /><br />Examples:<br />
      operationId: getCardPortsUsingGET
      parameters:
      - name: cardFdn
        in: path
        description: cardFdn
        required: true
        style: simple
        schema:
          type: string
      - name: filter
        in: query
        description: "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')"
        style: form
        explode: true
        schema:
          type: string
      - name: networkElementFdn
        in: path
        description: networkElementFdn
        required: true
        style: simple
        schema:
          type: string
      - name: shelfFdn
        in: path
        description: shelfFdn
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK - Request executed successfully
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Port'
                description: ''
        '400':
          description: Bad Request - Malformed content or invalid parameter data provided
          headers: {}
          content: {}
        '401':
          description: Unauthorized - Authentication rejected
          headers: {}
          content: {}
        '403':
          description: Forbidden - No user access to the resource
          headers: {}
          content: {}
        '404':
          description: Not Found - URL or resource does not exist
          headers: {}
          content: {}
        '405':
          description: Method Not Allowed - HTTP method not allowed for this endpoint
          headers: {}
          content: {}
        '422':
          description: Unprocessable Entity - Invalid FDN provided
          headers: {}
          content: {}
        '500':
          description: Internal Server Error - Server error
          headers: {}
          content: {}
      deprecated: false
      security:
      - RESTToken:
        - global
  /v1/networkElements/{networkElementFdn}/shelves/{shelfFdn}/ports:
    get:
      tags:
      - networkElements
      summary: getShelfPortsUsingGET
      description: 'Returns a list of specific ports. The list will contain the FDN of each resulting port. Not providing a filter will return all ports.<br /><br /><strong>Filterable properties:</strong> <br /><strong>sourceType:</strong> The type of the source system. For example: <i>nfmp</i> <br /><strong>sourceSystem:</strong> The partial FDN identifying the source system. For example: <i>fdn:realm:sam</i> <br /><strong>name:</strong> The user friendly visible name <br /><strong>neName:</strong> The name of the Network Element containing this Port <br /><strong>neId:</strong> The id of the Network Element containing this Port <br /><strong>description:</strong> The detailed description of the Port  <br /><strong>positionId:</strong> The relative position of the Port that determines the order in which to show it in the source system UI<br /><strong>position:</strong> A formatted name that describes the position of the Port within the Shelf<br /><strong>adminState:</strong> The administrative state <br /><strong>operState:</strong> The operational state <br /><strong>standbyState:</strong> The standby state <br /><strong>availabilityStates:</strong> The availability state <br /><strong>stateReasons:</strong> A set of specific reasons why the Port is in this state   <br /><strong>objectDetails:</strong> Generic properties of the Port <br /><strong>manufacturer:</strong> The vendor of the Port <br /><strong>serialNumber:</strong> The serial number of the Port provided by the manufacturer <br /><strong>partNumber:</strong> The part number of the Port provided by the manufacturer <br /><strong>manufacturerAssemblyNumber:</strong> The assembly number of the Port provided by the manufacturer <br /><strong>manufactureDate:</strong> The date of manufacture of the Port <br /><strong>manufacturingDeviations:</strong> The manufacturing deviations of the Port provided by the manufacturer <br /><strong>macAddress:</strong> The base MAC Address of the Port <br /><strong>hwMacAddress:</strong> The Hardware MAC Address of the Port <br /><br />Examples:<br />'
      operationId: getShelfPortsUsingGET
      parameters:
      - name: filter
        in: query
        description: "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')"
        style: form
        explode: true
        schema:
          type: string
      - name: networkElementFdn
        in: path
        description: networkElementFdn
        required: true
        style: simple
        schema:
          type: string
      - name: shelfFdn
        in: path
        description: shelfFdn
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK - Request executed successfully
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Port'
                description: ''
        '400':
          description: Bad Request - Malformed content or invalid parameter data provided
          headers: {}
          content: {}
        '401':
          description: Unauthorized - Authentication rejected
          headers: {}
          content: {}
        '403':
          description: Forbidden - No user access to the resource
          headers: {}
          content: {}
        '404':
          description: Not Found - URL or resource does not exist
          headers: {}
          content: {}
        '405':
          description: Method Not Allowed - HTTP method not allowed for this endpoint
          headers: {}
          content: {}
        '422':
          description: Unprocessable Entity - Invalid FDN provided
          headers: {}
          content: {}
        '500':
          description: Internal Server Error - Server error
          headers: {}
          content: {}
      deprecated: false
      security:
      - RESTToken:
        - global
  /v1/physicalLinks:
    get:
      tags:
      - physicalLinks
      summary: getPhysicalLinksUsingGET
      description: "Returns a paged list of specific physical links. The size of each page is determined by the 'limit' query parameter. The list will contain the FDN of each resulting physical link. Not providing a filter will return all physical links.<br /><br /><strong>Filterable properties:</strong> <br /><strong>sourceType:</strong> The type of the source system. For example: <i>nfmp</i> <br /><strong>sourceSystem:</strong> The partial FDN identifying the source system. For example: <i>fdn:realm:sam</i> <br /><strong>name:</strong> The user friendly visible name <br /><strong>id:</strong> The short identifier of the Physical Link <br /><strong>type:</strong> The type of the Physical Link <br /><strong>rate:</strong> The rate label of the Physical Link <br /><strong>actualRate:</strong> The rate of the Physical Link, in units specified by the ‘actualRateUnits’ field value <br /><strong>actualRateUnits:</strong> The units associated to the ‘actualRate’ field value for the Physical Link <br /><strong>description:</strong> The detailed description of this Physical Link <br /><strong>protection:</strong> Indicates if the Physical Link is protected or unprotected <br /><strong>protectionKind:</strong> The type of protection for the Physical Link <br /><strong>latency:</strong> The latency of the Physical Link, if known, in units specified by the ‘latencyUnits’ field value <br /><strong>latencyUnits:</strong> The units associated to the ‘latency’ field value for the Physical Link <br /><strong>restoration:</strong> The restoration type for the Physical Link <br /><strong>direction:</strong> The direction of the Physical Link <br /><strong>adminState:</strong> The administrative state <br /><strong>operState:</strong> The operational state <br /><strong>standbyState:</strong> The standby state <br /><strong>availabilityStates:</strong> The availability state <br /><strong>objectDetails:</strong> Generic properties of the Physical Link <br /><br />Examples:<br />Get all physical links:  GET /v1/physicalLinks<br />Get all physical links, using a comma-separated list of FDNs:  GET /v1/physicalLinks?fdns=fdn:model:service:Service:2410,fdn:model:service:Service:2411<br />Get all physical links, with filter by direction:  GET /v1/physicalLinks?filter=direction%3D'biDirectional'<br />Get all physical links, with filter by latency:  GET /v1/physicalLinks?filter=NOT%20(latency%3D0)<br />Get all physical links, with filter by combined criteria:  GET /v1/physicalLinks?filter=direction%3D'biDirectional'%20AND%20NOT%20(latency%3D0)<br />Get all physical links, including NE data: GET /v1/physicalLinks?neFetch=true"
      operationId: getPhysicalLinksUsingGET
      parameters:
      - name: fdns
        in: query
        description: A comma-separated list of the Fully Distinguished Names of the NSP objects to query for.
        style: form
        explode: true
        schema:
          type: string
      - name: filter
        in: query
        description: "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')"
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: 'The limit on the number of objects returned (max: 1000)'
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 300
      - name: neFetch
        in: query
        description: A boolean value to determine whether to fetch NE data
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: offset
        in: query
        description: 'Start row for paged data (max: total number of objects)'
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      responses:
        '200':
          description: OK - Request executed successfully
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PhysicalLink'
                description: ''
        '400':
          description: Bad Request - Malformed content or invalid parameter data provided
          headers: {}
          content: {}
        '401':
          description: Unauthorized - Authentication rejected
          headers: {}
          content: {}
        '404':
          description: Not Found - URL or resource does not exist
          headers: {}
          content: {}
        '405':
          description: Method Not Allowed - HTTP method not allowed for this endpoint
          headers: {}
          content: {}
        '500':
          description: Internal Server Error - Server error
          headers: {}
          content: {}
      deprecated: false
      security:
      - RESTToken:
        - global
    post:
      tags:
      - physicalLinks
      summary: createPhysicalLinkUsingPOST
      description: This API allows admin users to create a 'cable' physical link manually. Endpoints can either be physicalPort to physicalPort or networkElement to networkElement or LAG to LAG.
      operationId: createPhysicalLinkUsingPOST
      parameters: []
      requestBody:
        description: physicalLink
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PhysicalLink'
              - description: physicalLink
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhysicalLink'
        '201':
          description: Created - Request executed successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhysicalLink'
        '400':
          description: Bad Request - Malformed content or invalid parameter data provided or operation failure
          headers: {}
          content: {}
        '401':
          description: Unauthorized - Authentication rejected
          headers: {}
          content: {}
        '403':
          description: Forbidden - No user access to the resource
          headers: {}
          content: {}
        '404':
          description: Not Found - URL or resource does not exist
          headers: {}
          content: {}
        '405':
          description: Method Not Allowed - HTTP method not allowed for this endpoint
          headers: {}
          content: {}
        '500':
          description: Internal Server Error - Server error
          headers: {}
          content: {}
      deprecated: false
      security:
      - RESTToken:
        - global
  /v1/physicalLinks/{physicalLinkFdn}:
    get:
      tags:
      - physicalLinks
      summary: getPhysicalLinkUsingGET
      description: Returns detailed information for the specified physical link.<br /><br />Example:<br />GET /v1/physicalLinks/fdn:model:service:Service:2410
      operationId: getPhysicalLinkUsingGET
      parameters:
      - name: physicalLinkFdn
        in: path
        description: physicalLinkFdn
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK - Request executed successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhysicalLink'
        '400':
          description: Bad Request - Malformed content or invalid parameter data provided
          headers: {}
          content: {}
        '401':
          description: Unauthorized - Authentication rejected
          headers: {}
          content: {}
        '404':
          description: Not Found - URL or resource does not exist
          headers: {}
          content: {}
        '405':
          description: Method Not Allowed - HTTP method not allowed for this endpoint
          headers: {}
          content: {}
        '422':
          description: Unprocessable Entity - Invalid FDN provided
          headers: {}
          content: {}
        '500':
          description: Internal Server Error - Server error
          headers: {}
          content: {}
      deprecated: false
      security:
      - RESTToken:
        - global
    delete:
      tags:
      - physicalLinks
      summary: deletePhysicalLinkUsingDELETE
      description: This API allows admin users to delete a manually created physical link.
      operationId: deletePhysicalLinkUsingDELETE
      parameters:
      - name: physicalLinkFdn
        in: path
        description: physicalLinkFdn
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Deleted - Request executed successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhysicalLink'
        '400':
          description: Bad Request - Malformed content or invalid parameter data provided or operation failure
          headers: {}
          content: {}
        '401':
          description: Unauthorized - Authentication rejected
          headers: {}
          content: {}
        '403':
          description: Forbidden - No user access to the resource
          headers: {}
          content: {}
        '404':
          description: Not Found - URL or resource does not exist
          headers: {}
          content: {}
        '405':
          description: Method Not Allowed - HTTP method not allowed for this endpoint
          headers: {}
          content: {}
        '500':
          description: Internal Server Error - Server error
          headers: {}
          content: {}
      deprecated: false
      security:
      - RESTToken:
        - global
  /v1/ports:
    get:
      tags:
      - ports
      summary: getPortsUsingGET
      description: "Returns a paged list of specific ports. The size of each page is determined by the 'limit' query parameter. The list will contain the FDN of each resulting port. Not providing a filter will return all ports.<br /><br /><strong>Filterable properties:</strong> <br /><strong>sourceType:</strong> The type of the source system. For example: <i>nfmp</i> <br /><strong>sourceSystem:</strong> The partial FDN identifying the source system. For example: <i>fdn:realm:sam</i> <br /><strong>name:</strong> The user friendly visible name <br /><strong>neName:</strong> The name of the Network Element containing this Port <br /><strong>neId:</strong> The id of the Network Element containing the Port <br /><strong>description:</strong> The detailed description of the Port  <br /><strong>positionId:</strong> The relative position of the Port that determines the order in which to show it in the source system UI<br /><strong>position:</strong> A formatted name that describes the position of the Port within the Network Element<br /><strong>adminState:</strong> The administrative state <br /><strong>operState:</strong> The operational state <br /><strong>standbyState:</strong> The standby state <br /><strong>availabilityStates:</strong> The availability state <br /><strong>stateReasons:</strong> A set of specific reasons why the Port is in this state   <br /><strong>objectDetails:</strong> Generic properties of the Port <br /><strong>manufacturer:</strong> The vendor of the Port <br /><strong>serialNumber:</strong> The serial number of the Port provided by the manufacturer <br /><strong>partNumber:</strong> The part number of the Port provided by the manufacturer <br /><strong>manufacturerAssemblyNumber:</strong> The assembly number of the Port provided by the manufacturer <br /><strong>manufactureDate:</strong> The date of manufacture of the Port <br /><strong>manufacturingDeviations:</strong> The manufacturing deviations of the Port provided by the manufacturer <br /><strong>macAddress:</strong> The base MAC Address of the Port <br /><strong>hwMacAddress:</strong> The Hardware MAC Address of the Port <br /><br />Examples:<br />Get all ports:  GET /v1/ports<br />Get all ports, using a comma-separated list of FDNs:  GET /v1/ports?fdns=fdn:model:equipment:Equipment:2189,fdn:model:equipment:Equipment:2190<br />Get all ports, with filter by name:  GET /v1/ports?filter=name%20LIKE%20'%25%2F3'<br />Get all ports, with filter by standbyState:  GET /v1/ports?filter=standbyState%3D'providingService'<br />Get all ports, with filter by combined criteria:  GET /v1/ports?filter=NOT%20(name%20LIKE%20'%25%2F3')%20AND%20standbyState%3D'providingService'"
      operationId: getPortsUsingGET
      parameters:
      - name: fdns
        in: query
        description: A comma-separated list of the Fully Distinguished Names of the NSP objects to query for.
        style: form
        explode: true
        schema:
          type: string
      - name: filter
        in: query
        description: "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')"
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: 'The limit on the number of objects returned (max: 1000)'
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 300
      - name: offset
        in: query
        description: 'Start row for paged data (max: total number of objects)'
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      responses:
        '200':
          description: OK - Request executed successfully
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Port'
                description: ''
        '400':
          description: Bad Request - Malformed content or invalid parameter data provided
          headers: {}
          content: {}
        '401':
          description: Unauthorized - Authentication rejected
          headers: {}
          content: {}
        '404':
          description: Not Found - URL or resource does not exist
          headers: {}
          content: {}
        '405':
          description: Method Not Allowed - HTTP method not allowed for this endpoint
          headers: {}
          content: {}
        '500':
          description: Internal Server Error - Server error
          headers: {}
          content: {}
      deprecated: false
      security:
      - RESTToken:
        - global
  /v1/ports/{portFdn}:
    get:
      tags:
      - ports
      summary: getPortUsingGET
      description: Returns detailed information for the specified port.<br /><br />Example:<br />GET /v1/ports/equipment:Equipment:2189
      operationId: getPortUsingGET
      parameters:
      - name: portFdn
        in: path
        description: portFdn
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK - Request executed successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Port'
        '400':
          description: Bad Request - Malformed content or invalid parameter data provided
          headers: {}
          content: {}
        '401':
          description: Unauthorized - Authentication rejected
          headers: {}
          content: {}
        '403':
          description: Forbidden - No user access to the resource
          headers: {}
          content: {}
        '404':
          description: Not Found - URL or resource does not exist
          headers: {}
          content: {}
        '405':
          description: Method Not Allowed - HTTP method not allowed for this endpoint
          headers: {}
          content: {}
        '422':
          description: Unprocessable Entity - Invalid FDN provided
          headers: {}
          content: {}
        '500':
          description: Internal Server Error - Server error
          headers: {}
          content: {}
      deprecated: false
      security:
      - RESTToken:
        - global
  /v1/radioEquipment:
    get:
      tags:
      - radioEquipment
      summary: getRadioEquipmentsUsingGET
      description: "Returns a paged list of specific radio equipments. The size of each page is determined by the 'limit' query parameter. The list will contain the FDN of each resulting Radio Equipment. Not providing a filter will return all Radio Equipments.<br /><br /><strong>Filterable properties:</strong> <br /><strong>sourceType:</strong> The type of the source system. For example: <i>nfmp</i> <br /><strong>sourceSystem:</strong> The partial FDN identifying the source system. For example: <i>fdn:realm:sam</i> <br /><strong>name:</strong> The name of the radio equipment, as defined by the source system <br /><strong>neName:</strong> The name of the radio equipment which is unique within the source system<br /><strong>neId:</strong> The id of the radio equipment <br /><strong>description:</strong> The detailed description of the radio equipment <br /><strong>ipAddress:</strong> The management IP address of the radio equipment <br /><strong>product:</strong> The vendor product name of the radio equipment <br /><strong>version:</strong> The version of the radio equipment <br /><strong>longitude:</strong> The longitude (in degrees) of the radio equipment, if known. Min = -180, Max = 180 <br /><strong>latitude:</strong> The latitude (in degrees) of the radio equipment, if known. Min = -90, Max = 90 <br /><strong>location:</strong> The location of the radio equipment <br /><strong>adminState:</strong> The administrative state <br /><strong>operState:</strong> The operational state <br /><strong>standbyState:</strong> The standby state <br /><strong>communicationState:</strong> The communication status of the radio equipment <br /><strong>availabilityStates:</strong> The availability state <br /><strong>objectDetails:</strong> Generic properties of the radio equipment <br /><strong>macAddress:</strong> The Mac address of the radio equipment<br /><strong>clliCode:</strong> Common Language Location Identifier (CLLI) code value for the system <br /><br />Examples:<br />Get all radio equipment:  GET /v1/radioEquipment<br />"
      operationId: getRadioEquipmentsUsingGET
      parameters:
      - name: fdns
        in: query
        description: A comma-separated list of the Fully Distinguished Names of the NSP objects to query for.
        style: form
        explode: true
        schema:
          type: string
      - name: filter
        in: query
        description: "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')"
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: 'The limit on the number of objects returned (max: 1000)'
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 300
      - name: offset
        in: query
        description: 'Start row for paged data (max: total number of objects)'
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      responses:
        '200':
          description: OK - Request executed successfully
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RadioEquipment'
                description: ''
        '400':
          description: Bad Request - Malformed content or invalid parameter data provided
          headers: {}
          content: {}
        '401':
          description: Unauthorized - Authentication rejected
          headers: {}
          content: {}
        '404':
          description: Not Found - URL or resource does not exist
          headers: {}
          content: {}
        '405':
          description: Method Not Allowed - HTTP method not allowed for this endpoint
          headers: {}
          content: {}
        '500':
          description: Internal Server Error - Server error
          headers: {}
          content: {}
      deprecated: false
      security:
      - RESTToken:
        - global
  /v1/radioEquipment/{radioEquipmentFdn}:
    get:
      tags:
      - radioEquipment
      summary: getRadioEquipmentUsingGET
      description: Returns detailed information for the specified radio equipment.<br /><br />Example:<br />
      operationId: getRadioEquipmentUsingGET
      parameters:
      - name: radioEquipmentFdn
        in: path
        description: radioEquipmentFdn
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK - Request executed successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RadioEquipment'
        '400':
          description: Bad Request - Malformed content or invalid parameter data provided
          headers: {}
          content: {}
        '401':
          description: Unauthorized - Authentication rejected
          headers: {}
          content: {}
        '403':
          description: Forbidden - No user access to the resource
          headers: {}
          content: {}
        '404':
          description: Not Found - URL or resource does not exist
          headers: {}
          content: {}
        '405':
          description: Method Not Allowed - HTTP method not allowed for this endpoint
          headers: {}
          content: {}
        '422':
          description: Unprocessable Entity - Invalid FDN provided
          headers: {}
          content: {}
        '500':
          description: Internal Server Error - Server error
          headers: {}
          content: {}
      deprecated: false
      security:
      - RESTToken:
        - global
  /v1/shelves:
    get:
      tags:
      - shelves
      summary: getShelvesUsingGET
      description: "Returns a paged list of specific shelves. The size of each page is determined by the 'limit' query parameter. The list will contain the FDN of each resulting shelf. Not providing a filter will return all shelves.<br /><br /><strong>Filterable properties:</strong> <br /><strong>sourceType:</strong> The type of the source system. For example: <i>nfmp</i> <br /><strong>sourceSystem:</strong> The partial FDN identifying the source system. For example: <i>fdn:realm:sam</i> <br /><strong>name:</strong> The user friendly visible name <br /><strong>neName:</strong> The name of the Network Element containing the Shelf <br /><strong>neId:</strong> The id of the Network Element containing the Shelf <br /><strong>description:</strong> The detailed description of the Shelf  <br /><strong>positionId:</strong> The relative position of the Shelf that determines the order in which to show it in the source system UI<br /><strong>position:</strong> A formatted name that describes the position of the Shelf within the Network Element<br /><strong>adminState:</strong> The administrative state <br /><strong>operState:</strong> The operational state <br /><strong>standbyState:</strong> The standby state <br /><strong>availabilityStates:</strong> The availability state <br /><strong>stateReasons:</strong> A set of specific reasons why the Shelf is in this state   <br /><strong>objectDetails:</strong> Generic properties of this Shelf <br /><strong>manufacturer:</strong> The vendor of the Shelf <br /><strong>serialNumber:</strong> The serial number of the Shelf provided by the manufacturer <br /><strong>partNumber:</strong> The part number of the Shelf provided by the manufacturer <br /><strong>manufacturerAssemblyNumber:</strong> The assembly number of the Shelf provided by the manufacturer <br /><strong>manufactureDate:</strong> The date of manufacture of the Shelf <br /><strong>manufacturingDeviations:</strong> The manufacturing deviations of the Shelf provided by the manufacturer <br /><strong>macAddress:</strong> The base MAC Address of the Shelf <br /><strong>hwMacAddress:</strong> The Hardware MAC Address of the Shelf <br /><br />Examples:<br />Get all shelves:  GET /v1/shelves<br />Get all shelves, using a comma-separated list of FDNs:  GET /v1/shelves?fdns=fdn:model:equipment:Equipment:2122,fdn:model:equipment:Equipment:2124<br />Get all shelves, with filter by standbyState:  GET /v1/shelves?filter=standbyState%3D'providingService'<br />Get all shelves, with filter by adminState:  GET /v1/shelves?filter=adminState%3D'unlocked'<br />Get all shelves, with filter by combined criteria:  GET /v1/shelves?filter=standbyState%3D'providingService'%20AND%20NOT%20(adminState%3D'locked')"
      operationId: getShelvesUsingGET
      parameters:
      - name: fdns
        in: query
        description: A comma-separated list of the Fully Distinguished Names of the NSP objects to query for.
        style: form
        explode: true
        schema:
          type: string
      - name: filter
        in: query
        description: "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')"
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: 'The limit on the number of objects returned (max: 1000)'
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 300
      - name: offset
        in: query
        description: 'Start row for paged data (max: total number of objects)'
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      responses:
        '200':
          description: OK - Request executed successfully
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Shelf'
                description: ''
        '400':
          description: Bad Request - Malformed content or invalid parameter data provided
          headers: {}
          content: {}
        '401':
          description: Unauthorized - Authentication rejected
          headers: {}
          content: {}
        '404':
          description: Not Found - URL or resource does not exist
          headers: {}
          content: {}
        '405':
          description: Method Not Allowed - HTTP method not allowed for this endpoint
          headers: {}
          content: {}
        '500':
          description: Internal Server Error - Server error
          headers: {}
          content: {}
      deprecated: false
      security:
      - RESTToken:
        - global
  /v1/shelves/{shelfFdn}:
    get:
      tags:
      - shelves
      summary: getShelfUsingGET
      description: Returns detailed information for the specified shelf.<br /><br />Example:<br />GET /v1/shelves/fdn:model:equipment:Equipment:2122
      operationId: getShelfUsingGET
      parameters:
      - name: shelfFdn
        in: path
        description: shelfFdn
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK - Request executed successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Shelf'
        '400':
          description: Bad Request - Malformed content or invalid parameter data provided
          headers: {}
          content: {}
        '401':
          description: Unauthorized - Authentication rejected
          headers: {}
          content: {}
        '403':
          description: Forbidden - No user access to the resource
          headers: {}
          content: {}
        '404':
          description: Not Found - URL or resource does not exist
          headers: {}
          content: {}
        '405':
          description: Method Not Allowed - HTTP method not allowed for this endpoint
          headers: {}
          content: {}
        '422':
          description: Unprocessable Entity - Invalid FDN provided
          headers: {}
          content: {}
        '500':
          description: Internal Server Error - Server error
          headers: {}
          content: {}
      deprecated: false
      security:
      - RESTToken:
        - global
components:
  schemas:
    Card:
      title: Card
      required:
      - fdn
      - sourceType
      - sourceSystem
      - sources
      - name
      - neName
      - neId
      - positionId
      - position
      - adminState
      - operState
      - standbyState
      - availabilityStates
      type: object
      properties:
        links:
          type: array
          items:
            $ref: '#/components/schemas/Link'
          description: ''
          xml:
            namespace: http://www.w3.org/2005/Atom
            attribute: false
            wrapped: false
        fdn:
          type: string
          description: The Fully Distinguished Name of this Card.
        sourceType:
          allOf:
          - $ref: '#/components/schemas/SourceType'
          - description: The type of the source system where this Card is sourced from.
        sourceSystem:
          type: string
          description: The source system where this Card is sourced from.
        sources:
          type: array
          items:
            type: string
          description: The Fully Distinguished Names of the Cards from the source system associated to this Card.
        name:
          type: string
          description: The name of this Card, as defined by the source system.
        neName:
          type: string
          description: The name of the Network Element containing this Card, as defined by the source system.
        neId:
          type: string
          description: The id of the Network Element containing this Card, as defined by the source system.
        description:
          type: string
          description: The detailed description of this Card.
        positionId:
          type: integer
          description: The relative position of the Card, that determines the order in which to show it in the source system UI.
          format: int64
        position:
          type: string
          description: A formatted name that describes the position of the Card within the Network Element.
        adminState:
          allOf:
          - $ref: '#/components/schemas/AdminState'
          - description: The administrative state of this Card. Refer to the X.731 standard.
        operState:
          allOf:
          - $ref: '#/components/schemas/OperState'
          - description: The operational state of this Card. Refer to the X.731 standard.
        standbyState:
          allOf:
          - $ref: '#/components/schemas/StandbyState'
          - description: The standby state of this Card. Refer to the X.731 standard.
        availabilityStates:
          type: array
          items:
            $ref: '#/components/schemas/AvailabilityState'
          description: The availability states of this Card. Refer to the X.731 standard.
        stateReasons:
          type: array
          items:
            type: string
          description: A set of specific reasons why the Card is in this state.
        objectDetails:
          type: object
          additionalProperties:
            type: string
          description: Generic properties of this Card, specific to the Network Supervision application.
        manufacturer:
          type: string
          description: The vendor of the Card.
        serialNumber:
          type: string
          description: The serial number of the Card provided by the manufacturer.
        partNumber:
          type: string
          description: The part number of the Card provided by the manufacturer.
        manufacturerAssemblyNumber:
          type: string
          description: The assembly number of the Card provided by the manufacturer.
        manufactureDate:
          type: string
          description: The date of manufacture of the Card.
        manufacturingDeviations:
          type: string
          description: The manufacturing deviations of the Card provided by the manufacturer.
        macAddress:
          type: string
          description: The Base MAC Address of the Card
        hwMacAddress:
          type: string
          description: The Hardware MAC Address of the Card
        cardDetails:
          $ref: '#/components/schemas/CardDetails'
    CardSlot:
      title: CardSlot
      required:
      - fdn
      - sourceType
      - sourceSystem
      - sources
      - name
      - neName
      - neId
      - positionId
      - position
      - adminState
      - operState
      - standbyState
      - availabilityStates
      - provisionedType
      - actualType
      - holderState
      type: object
      properties:
        links:
          type: array
          items:
            $ref: '#/components/schemas/Link'
          description: ''
          xml:
            namespace: http://www.w3.org/2005/Atom
            attribute: false
            wrapped: false
        fdn:
          type: string
          description: The Fully Distinguished Name of this Card Slot.
        sourceType:
          allOf:
          - $ref: '#/components/schemas/SourceType2'
          - description: The type of the source system where this Card Slot is sourced from.
        sourceSystem:
          type: string
          description: The source system where this Card Slot is sourced from.
        sources:
          type: array
          items:
            type: string
          description: The Fully Distinguished Names of the Card Slots from the source system associated to this Card Slot.
        name:
          type: string
          description: The name of this Card Slot, as defined by the source system.
        neName:
          type: string
          description: The name of the Network Element containing this Card Slot, as defined by the source system.
        neId:
          type: string
          description: The id of the Network Element containing this Card Slot, as defined by the source system.
        description:
          type: string
          description: The detailed description of this Card Slot.
        positionId:
          type: integer
          description: The relative position of the Card Slot, that determines the order in which to show it in the source system UI.
          format: int64
        position:
          type: string
          description: A formatted name that describes the position of the Card Slot within the Network Element.
        adminState:
          allOf:
          - $ref: '#/components/schemas/AdminState1'
          - description: The administrative state of this Card Slot. Refer to the X.731 standard.
        operState:
          allOf:
          - $ref: '#/components/schemas/OperState1'
          - description: The operational state of this Card Slot. Refer to the X.731 standard.
        standbyState:
          allOf:
          - $ref: '#/components/schemas/StandbyState1'
          - description: The standby state of this Card Slot. Refer to the X.731 standard.
        availabilityStates:
          type: array
          items:
            $ref: '#/components/schemas/AvailabilityState'
          description: The availability states of this Card Slot. Refer to the X.731 standard.
        stateReasons:
          type: array
          items:
            type: string
          description: A set of specific reasons why the Card Slot is in this state.
        objectDetails:
          type: object
          additionalProperties:
            type: string
          description: Generic properties of this Card Slot, specific to the Network Supervision application.
        manufacturer:
          type: string
          description: The vendor of the Card Slot.
        serialNumber:
          type: string
          description: The serial number of the Card Slot provided by the manufacturer.
        partNumber:
          type: string
          description: The part number of the Card Slot provided by the manufacturer.
        manufacturerAssemblyNumber:
          type: string
          description: The assembly number of the Card Slot provided by the manufacturer.
        manufactureDate:
          type: string
          description: The date of manufacture of the Card Slot.
        manufacturingDeviations:
          type: string
          description: The manufacturing deviations of the Card Slot provided by the manufacturer.
        macAddress:
          type: string
          description: The Base MAC Address of the Card Slot
        hwMacAddress:
          type: string
          description: The Hardware MAC Address of the Card Slot
        provisionedType:
          type: string
          description: The type of Card provisioned in this Card Slot.
        actualType:
          type: string
          description: The type of Card present in this Card Slot.
        holderState:
          type: string
          description: The status of the Card Slot.
    CardDetails:
      title: CardDetails
      type: object
      properties:
        fdn:
          type: string
          example: fdn:model:equipment:CardDetails:2203
        sourceType:
          allOf:
          - $ref: '#/components/schemas/SourceType1'
          - example: nfmp
        sourceSystem:
          type: string
          example: fdn:realm:sam
        sources:
          type: array
          items:
            type: string
          description: ''
          example:
          - fdn:realm:sam:network:38.120.169.111:shelf-1:cardSlot-2:card@cardDetails
        objectDetails:
          type: object
          additionalProperties:
            type: string
        cardType:
          type: string
          description: The type of this Card.
          example: 500g CPM / Switch Fabric 3
        equippedPorts:
          type: integer
          description: The number of ports equipped directly on this Card.
          format: int32
          example: 40
        capabilities:
          type: array
          items:
            type: string
          description: A set of specific capabilities of the Card.
        availableSlots:
          type: integer
          description: The number of available card slots on this Card.
          format: int32
          example: 2
        installedSlots:
          type: integer
          description: The number of installed slots on this Card.
          format: int32
          example: 1
        memorySize:
          type: integer
          description: The Memory Size of this Card in MB.
          format: int64
          example: 16392
        lastBootUpReason:
          type: string
          description: The last boot-up reason of this Card.
          example: Hard Reboot
    LAG:
      title: LAG
      required:
      - fdn
      - sourceType
      - sourceSystem
      - sources
      - lagId
      - neName
      - neId
      - name
      - encapType
      - adminState
      - operState
      - standbyState
      - parentNe
      type: object
      properties:
        links:
          type: array
          items:
            $ref: '#/components/schemas/Link'
          description: ''
          xml:
            namespace: http://www.w3.org/2005/Atom
            attribute: false
            wrapped: false
        fdn:
          type: string
          description: The Fully Distinguished Name of this LAG.
        sourceType:
          allOf:
          - $ref: '#/components/schemas/SourceType3'
          - description: The type of the source system where this LAG is sourced from.
        sourceSystem:
          type: string
          description: The source system where this LAG is sourced from.
        sources:
          type: array
          items:
            type: string
          description: The Fully Distinguished Names of the LAGs from the source system associated to this LAG.
        lagId:
          type: string
          description: The short identifier of this LAG, as defined by the source system
        neName:
          type: string
          description: The name of this LAG. Is unique within the source system.
        neId:
          type: string
          description: The id of this LAG. Is unique within the source system.
        name:
          type: string
          description: The name of this LAG, as defined by the source system.
        description:
          type: string
          description: The detailed description of this LAG.
        configuredAddress:
          type: string
          description: The MAC Address of this LAG.
        encapType:
          allOf:
          - $ref: '#/components/schemas/EncapType'
          - description: The encapsulation type of this LAG.
        operationalSpeedUnits:
          type: string
          description: The units associated to the 'operationalSpeed' field value for this LAG.
        operationalSpeed:
          type: number
          description: The total operational speed of this LAG, in units specified by the 'operationalSpeedUnits' field value.
        lagMode:
          allOf:
          - $ref: '#/components/schemas/LagMode'
          - description: The mode of this LAG.
        adminState:
          allOf:
          - $ref: '#/components/schemas/AdminState2'
          - description: The administrative state of this LAG. Refer to the X.731 standard.
        operState:
          allOf:
          - $ref: '#/components/schemas/OperState2'
          - description: The operational state of this LAG. Refer to the X.731 standard.
        standbyState:
          allOf:
          - $ref: '#/components/schemas/StandbyState2'
          - description: The standby state of this LAG. Refer to the X.731 standard
        availabilityStates:
          type: array
          items:
            $ref: '#/components/schemas/AvailabilityState'
          description: The availability states of this LAG. Refer to the X.731 standard.
        stateReasons:
          type: array
          items:
            type: string
          description: A set of specific reasons why the LAG is in this state.
        objectDetails:
          type: object
          additionalProperties:
            type: string
          description: Generic properties of this LAG, specific to the Network Supervision application
        members:
          type: array
          items:
            $ref: '#/components/schemas/LAGMemberDetails'
          description: ''
        multiChassisLAGMembers:
          type: array
          items:
            $ref: '#/components/schemas/MultiChassisLAGMember'
          description: ''
        parentNe:
          type: string
          description: The Fully Distinguished Name of the Network Element containing this LAG.
        parent:
          type: string
          description: The Fully Distinguished Name of the Radio Equipment containing this LAG.
    LAGMemberDetails:
      title: LAGMemberDetails
      type: object
      properties:
        encapType:
          type: string
        fdn:
          type: string
        lagId:
          type: string
        objectDetails:
          type: object
          additionalProperties:
            type: string
        portFdn:
          type: string
        portName:
          type: string
        priority:
          type: integer
          format: int64
        sourceSystem:
          type: string
        sourceType:
          type: string
        sources:
          type: array
          items:
            type: string
          description: ''
        standbyState:
          type: string
    Link:
      title: Link
      type: object
      properties:
        href:
          type: string
          xml:
            name: href
            attribute: true
            wrapped: false
        rel:
          type: string
          xml:
            name: rel
            attribute: true
            wrapped: false
        templated:
          type: boolean
    MultiChassisLAGMember:
      title: MultiChassisLAGMember
      type: object
      properties:
        description:
          type: string
        fdn:
          type: string
        lacpKey:
          type: integer
          format: int64
        objectDetails:
          type: object
          additionalProperties:
            type: string
        peerIpAddress:
          type: string
        peerNeId:
          type: string
        remoteLagId:
          type: string
        sourceSystem:
          type: string
        sourceType:
          type: string
        sources:
          type: array
          items:
            type: string
          description: ''
        standbyState:
          type: string
        systemId:
          type: string
        systemPriority:
          type: integer
          format: int64
    NetworkElement:
      title: NetworkElement
      required:
      - fdn
      - sourceType
      - sourceSystem
      - sources
      - name
      - neName
      - neId
      - ipAddress
      - type
      - product
      - version
      - resyncState
      - managedState
      - adminState
      - operState
      - standbyState
      - communicationState
      type: object
      properties:
        links:
          type: array
          items:
            $ref: '#/components/schemas/Link'
          description: ''
          xml:
            namespace: http://www.w3.org/2005/Atom
            attribute: false
            wrapped: false
        fdn:
          type: string
          description: The Fully Distinguished Name of this Network Element.
        sourceType:
          allOf:
          - $ref: '#/components/schemas/SourceType4'
          - description: The type of the source system where this Network Element is sourced from.
        sourceSystem:
          type: string
          description: The source system where this Network Element is sourced from.
        sources:
          type: array
          items:
            type: string
          description: The Fully Distinguished Names of the Network Elements from the source system associated to this Network Element.
        name:
          type: string
          description: The name of this Network Element, as defined by the source system.
        neName:
          type: string
          description: The name of this Network Element. Is unique within the source system.
        neId:
          type: string
          description: The identifier of this Network Element. Is unique within the source system.
        description:
          type: string
          description: The detailed description of this Network Element.
        ipAddress:
          type: string
          description: The management IP address of this Network Element.
        type:
          type: string
          description: The type of this Network Element.
        product:
          type: string
          description: The vendor product name of this Network Element.
        version:
          type: string
          description: The version of this Network Element.
        resyncState:
          allOf:
          - $ref: '#/components/schemas/ResyncState'
          - description: The resynchronization status of this Network Element.
        managedState:
          allOf:
          - $ref: '#/components/schemas/ManagedState'
          - description: The management state of this Network Element.
        longitude:
          type: number
          description: The longitude (in degrees) of this Network Element, if known. Min = -180, Max = 180
        latitude:
          type: number
          description: The latitude (in degrees) of this Network Element, if known. Min = -90, Max = 90
        location:
          type: string
          description: The location of this Network Element.
        topologyGroup:
          type: string
          description: The Fully Distinguished Name of the topology group that this Network Element belongs to, if any.
        adminState:
          allOf:
          - $ref: '#/components/schemas/AdminState3'
          - description: The administrative state of this Network Element. Refer to the X.731 standard.
        operState:
          allOf:
          - $ref: '#/components/schemas/OperState3'
          - description: The operational state of this Network Element. Refer to the X.731 standard.
        standbyState:
          allOf:
          - $ref: '#/components/schemas/StandbyState3'
          - description: The standby state of this Network Element. Refer to the X.731 standard.
        availabilityStates:
          type: array
          items:
            $ref: '#/components/schemas/AvailabilityState'
          description: The availability states of this Network Element. Refer to the X.731 standard.
        objectDetails:
          type: object
          additionalProperties:
            type: string
          description: Generic properties of this Network Element, specific to the Network Supervision application.
        networkType:
          allOf:
          - $ref: '#/components/schemas/NetworkType'
          - description: The type of network this Network Element is part of.
        communicationState:
          allOf:
          - $ref: '#/components/schemas/CommunicationState'
          - description: The communication status of this Network Element. Specifies if the management system can reach the Network Element, using one of its supported management protocols.
        communicationStateDetails:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ReachabilityStatus'
          description: The reachability status of each supported management protocol of this Network Element.
        macAddress:
          type: string
          description: The Mac address of this Network Element.
        clliCode:
          type: string
          description: Common Language Location Identifier (CLLI) code value for the system.
    PhysicalLink:
      title: PhysicalLink
      required:
      - name
      - id
      - type
      - endpoints
      type: object
      properties:
        links:
          type: array
          items:
            $ref: '#/components/schemas/Link'
          description: ''
          xml:
            namespace: http://www.w3.org/2005/Atom
            attribute: false
            wrapped: false
        sourceType:
          type: string
          description: The type of the source system where this Service is sourced from. Read only.
        fdn:
          type: string
          description: The Fully Distinguished Name of the Physical Link. Read only.
        sourceSystem:
          type: string
          description: The source system where this Service is sourced from. Read only.
        sources:
          type: array
          items:
            type: string
          description: The Fully Distinguished Names of the Physical Links from the source system associated to this Physical Link. Read only.
        name:
          type: string
          description: The user-friendly name of this Physical Link. Mandatory property for creation.
        id:
          type: string
          description: The short identifier of this Physical Link. Mandatory property for creation.
        type:
          type: string
          description: The type of this Physical Link. Mandatory property for creation.
        rate:
          type: string
          description: The rate label of this Physical Link. Defaults to null value.
        actualRate:
          type: number
          description: The rate of this Physical Link, in units specified by the 'actualRateUnits' field value. Defaults to null value.
        actualRateUnits:
          allOf:
          - $ref: '#/components/schemas/ActualRateUnits'
          - description: The units associated to the 'actualRate' field value for this Physical Link. Default to 'unknown'.
        description:
          type: string
          description: The detailed description of this Physical Link.
        protection:
          allOf:
          - $ref: '#/components/schemas/Protection'
          - description: Indicates if this Physical Link is protected or unprotected. Defaults to 'unknown'.
        protectionKind:
          allOf:
          - $ref: '#/components/schemas/ProtectionKind'
          - description: The type of protection for this Physical Link. Defaults to 'unknown'.
        latency:
          type: integer
          description: The latency of this Physical Link, if known, in units specified by the 'latencyUnits' field value. Defaults to 0.
          format: int64
        latencyUnits:
          allOf:
          - $ref: '#/components/schemas/LatencyUnits'
          - description: The units associated to the 'latency' field value for this Physical Link. Default to 'unknown'.
        restoration:
          allOf:
          - $ref: '#/components/schemas/Restoration'
          - description: The restoration type for this Physical Link. Defaults to 'unknown'.
        direction:
          allOf:
          - $ref: '#/components/schemas/Direction'
          - description: The direction of this Physical Link. Defaults to 'unknown'.
        adminState:
          allOf:
          - $ref: '#/components/schemas/AdminState4'
          - description: The adminstrative state of this Physical Link. Defaults to 'unknown'. Refer to the X.731 standard.
        operState:
          allOf:
          - $ref: '#/components/schemas/OperState4'
          - description: The operational state of this Physical Link. Read only. Defaults to 'unknown'. Refer to the X.731 standard.
        standbyState:
          allOf:
          - $ref: '#/components/schemas/StandbyState4'
          - description: The standby state of this Physical Link. Defaults to 'providingService'. Refer to the X.731 standard.
        availabilityStates:
          type: array
          items:
            $ref: '#/components/schemas/AvailabilityState'
          description: The availability states of this Physical Link. Defaults to 'unknown', if present. Refer to the X.731 standard
        objectDetails:
          type: object
          additionalProperties:
            type: string
          description: Generic properties of this Physical Link, specific to the Network Supervision application.
        endpoints:
          type: array
          items:
            $ref: '#/components/schemas/PhysicalLinkEndpoint'
          description: The Endpoints associated to this Physical Link. Mandatory property for creation.
    PhysicalLinkEndpoint:
      title: PhysicalLinkEndpoint
      required:
      - type
      - port
      - lag
      - parentNe
      - parentNeId
      type: object
      properties:
        name:
          type: string
          description: The name of this Physical Link Endpoint. Defaults to null value.
          example: Port 1/1/1
        type:
          allOf:
          - $ref: '#/components/schemas/Type'
          - description: The type of this Physical Link Endpoint. Mandatory property for creation.
            example: physicalPort
        port:
          type: string
          description: The Fully Distinguished Name of the Port to use. Mandatory property for creation, if and only if 'type' value is 'physicalPort'.
          example: fdn:model:equipment:Equipment:2189
        lag:
          type: string
          description: The Fully Distinguished Name of the LAG to use. Mandatory property for creation, if and only if 'type' value is 'lag'.
          example: 'null'
        parentNe:
          type: string
          description: The Fully Distinguished Name of the Network Element containing this Physical Link Endpoint. Mandatory property for creation.
          example: fdn:model:equipment:NetworkElement:2102
        parentNeId:
          type: string
          description: The identifier of the Network Element containing this Physical Link Endpoint. Mandatory property for creation.
          example: 38.120.169.111
        subnetName:
          type: string
          description: Will always be null, for the 'physicalPort', 'networkElement' and 'lag' types. Defaults to null value.
          example: 'null'
        objectDetails:
          type: object
          additionalProperties:
            type: string
          description: Generic properties of this Physical Link Endpoint, specific to the Network Supervision application.
        parentNeName:
          type: string
          description: The name of the Network Element containing this Physical Link Endpoint
    Port:
      title: Port
      required:
      - fdn
      - sourceType
      - sourceSystem
      - sources
      - name
      - neName
      - neId
      - positionId
      - position
      - adminState
      - operState
      - standbyState
      - availabilityStates
      type: object
      properties:
        links:
          type: array
          items:
            $ref: '#/components/schemas/Link'
          description: ''
          xml:
            namespace: http://www.w3.org/2005/Atom
            attribute: false
            wrapped: false
        fdn:
          type: string
          description: The Fully Distinguished Name of this Port.
        sourceType:
          allOf:
          - $ref: '#/components/schemas/SourceType5'
          - description: The type of the source system where this Port is sourced from.
        sourceSystem:
          type: string
          description: The source system where this Port is sourced from.
        sources:
          type: array
          items:
            type: string
          description: The Fully Distinguished Names of the Ports from the source system associated to this Port.
        name:
          type: string
          description: The name of this Port, as defined by the source system.
        neName:
          type: string
          description: The name of the Network Element containing this Port, as defined by the source system.
        neId:
          type: string
          description: The id of the Network Element containing this Port, as defined by the source system.
        description:
          type: string
          description: The detailed description of this Port.
        positionId:
          type: integer
          description: The relative position of the Port, that determines the order in which to show it in the source system UI.
          format: int64
        position:
          type: string
          description: A formatted name that describes the position of the Port within the Network Element.
        adminState:
          allOf:
          - $ref: '#/components/schemas/AdminState5'
          - description: The administrative state of this Port. Refer to the X.731 standard.
        operState:
          allOf:
          - $ref: '#/components/schemas/OperState5'
          - description: The operational state of this Port. Refer to the X.731 standard.
        standbyState:
          allOf:
          - $ref: '#/components/schemas/StandbyState5'
          - description: The standby state of this Port. Refer to the X.731 standard.
        availabilityStates:
          type: array
          items:
            $ref: '#/components/schemas/AvailabilityState'
          description: The availability states of this Port. Refer to the X.731 standard.
        stateReasons:
          type: array
          items:
            type: string
          description: A set of specific reasons why the Port is in this state.
        objectDetails:
          type: object
          additionalProperties:
            type: string
          description: Generic properties of this Port, specific to the Network Supervision application.
        manufacturer:
          type: string
          description: The vendor of the Port.
        serialNumber:
          type: string
          description: The serial number of the Port provided by the manufacturer.
        partNumber:
          type: string
          description: The part number of the Port provided by the manufacturer.
        manufacturerAssemblyNumber:
          type: string
          description: The assembly number of the Port provided by the manufacturer.
        manufactureDate:
          type: string
          description: The date of manufacture of the Port.
        manufacturingDeviations:
          type: string
          description: The manufacturing deviations of the Port provided by the manufacturer.
        macAddress:
          type: string
          description: The Configured MAC Address of the Port
        hwMacAddress:
          type: string
          description: The Hardware MAC Address of the Port
        portDetails:
          $ref: '#/components/schemas/PortDetails'
        lagDetails:
          $ref: '#/components/schemas/LAGMemberDetails'
    PortDetails:
      title: PortDetails
      required:
      - portMode
      type: object
      properties:
        fdn:
          type: string
          example: fdn:model:equipment:PortDetails:2209
        sourceType:
          allOf:
          - $ref: '#/components/schemas/SourceType1'
          - example: nfmp
        sourceSystem:
          type: string
          example: fdn:realm:sam
        sources:
          type: array
          items:
            type: string
          description: ''
          example:
          - fdn:realm:sam:network:38.120.169.111:shelf-1:cardSlot-2:card:port-1@portDetails
        objectDetails:
          type: object
          additionalProperties:
            type: string
        portIndex:
          type: integer
          description: The index of this Port. Generally, this is the SNMP 'ifIndex', if available.
          format: int64
          example: 67141632
        portType:
          allOf:
          - $ref: '#/components/schemas/PortType'
          - description: The type of this Port.
            example: ethernet
        rate:
          type: string
          description: The rate label of this Port.
          example: ethernet100
        actualRateUnits:
          allOf:
          - $ref: '#/components/schemas/ActualRateUnits1'
          - description: The units associated to the 'actualRate' field value for this Port.
            example: kbps
        actualRate:
          type: number
          description: The rate of this Port, in units specified by the 'actualRateUnits' field value.
          example: 100000
        portMode:
          allOf:
          - $ref: '#/components/schemas/PortMode'
          - description: The mode of port.
            example: access
        encapType:
          allOf:
          - $ref: '#/components/schemas/EncapType1'
          - description: The Encapsulation type of the port
            example: dot1q
        mtuValue:
          type: integer
          description: The MTU value of the port in bytes.
          format: int32
          example: 1578
    RadioEquipment:
      title: RadioEquipment
      type: object
      properties:
        adminState:
          type: string
        availabilityStates:
          type: array
          items:
            type: string
          description: ''
        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:
            $ref: '#/components/schemas/Link'
          description: ''
          xml:
            namespace: http://www.w3.org/2005/Atom
            attribute: false
            wrapped: false
        location:
          type: string
        longitude:
          type: number
        macAddress:
          type: string
        managedState:
          type: string
        name:
          type: string
        neId:
          type: string
        neName:
          type: string
        objectDetails:
          type: object
          additionalProperties:
            type: string
        operState:
          type: string
        parentNeName:
          type: string
        product:
          type: string
        resyncState:
          type: string
        sourceSystem:
          type: string
        sourceType:
          type: string
        sources:
          type: array
          items:
            type: string
          description: ''
        standbyState:
          type: string
        systemAddress:
          type: string
        version:
          type: string
    ReachabilityStatus:
      title: ReachabilityStatus
      type: object
      properties:
        address:
          type: string
        lastAttempt:
          type: integer
          format: int64
        protocol:
          type: string
        state:
          type: string
    ResponseDataCardSlot:
      title: ResponseDataCardSlot
      type: object
      properties:
        response:
          $ref: '#/components/schemas/ResponseCardSlot'
    ResponseDataCard:
      title: ResponseDataCard
      type: object
      properties:
        response:
          $ref: '#/components/schemas/ResponseCard'
    ResponseDataLAG:
      title: ResponseDataLAG
      type: object
      properties:
        response:
          $ref: '#/components/schemas/ResponseLAG'
    ResponseDataListCardSlot:
      title: ResponseDataListCardSlot
      type: object
      properties:
        response:
          $ref: '#/components/schemas/ResponseListCardSlot'
    ResponseDataListCard:
      title: ResponseDataListCard
      type: object
      properties:
        response:
          $ref: '#/components/schemas/ResponseListCard'
    ResponseDataListLAGMemberDetails:
      title: ResponseDataListLAGMemberDetails
      type: object
      properties:
        response:
          $ref: '#/components/schemas/ResponseListLAGMemberDetails'
    ResponseDataListLAG:
      title: ResponseDataListLAG
      type: object
      properties:
        response:
          $ref: '#/components/schemas/ResponseListLAG'
    ResponseDataListNetworkElement:
      title: ResponseDataListNetworkElement
      type: object
      properties:
        response:
          $ref: '#/components/schemas/ResponseListNetworkElement'
    ResponseDataListPhysicalLink:
      title: ResponseDataListPhysicalLink
      type: object
      properties:
        response:
          $ref: '#/components/schemas/ResponseListPhysicalLink'
    ResponseDataListPort:
      title: ResponseDataListPort
      type: object
      properties:
        response:
          $ref: '#/components/schemas/ResponseListPort'
    ResponseDataListRadioEquipment:
      title: ResponseDataListRadioEquipment
      type: object
      properties:
        response:
          $ref: '#/components/schemas/ResponseListRadioEquipment'
    ResponseDataListShelf:
      title: ResponseDataListShelf
      type: object
      properties:
        response:
          $ref: '#/components/schemas/ResponseListShelf'
    ResponseDataNetworkElement:
      title: ResponseDataNetworkElement
      type: object
      properties:
        response:
          $ref: '#/components/schemas/ResponseNetworkElement'
    ResponseDataPhysicalLink:
      title: ResponseDataPhysicalLink
      type: object
      properties:
        response:
          $ref: '#/components/schemas/ResponsePhysicalLink'
    ResponseDataPort:
      title: ResponseDataPort
      type: object
      properties:
        response:
          $ref: '#/components/schemas/ResponsePort'
    ResponseDataRadioEquipment:
      title: ResponseDataRadioEquipment
      type: object
      properties:
        response:
          $ref: '#/components/schemas/ResponseRadioEquipment'
    ResponseDataShelf:
      title: ResponseDataShelf
      type: object
      properties:
        response:
          $ref: '#/components/schemas/ResponseShelf'
    ResponseCardSlot:
      title: ResponseCardSlot
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CardSlot'
        endRow:
          type: integer
          format: int64
        errors:
          type: array
          items:
            type: object
          description: ''
        nextPage:
          type: string
          description: (Optional) A paged URL request pointing to the next page of data, or "null" if there is no next page.
        previousPage:
          type: string
          description: (Optional) A paged URL request pointing to the previous page of data, or "null" if there is no previous page.
        startRow:
          type: integer
          format: int64
        status:
          type: integer
          format: int32
        totalRows:
          type: integer
          format: int64
    ResponseCard:
      title: ResponseCard
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Card'
        endRow:
          type: integer
          format: int64
        errors:
          type: array
          items:
            type: object
          description: ''
        nextPage:
          type: string
          description: (Optional) A paged URL request pointing to the next page of data, or "null" if there is no next page.
        previousPage:
          type: string
          description: (Optional) A paged URL request pointing to the previous page of data, or "null" if there is no previous page.
        startRow:
          type: integer
          format: int64
        status:
          type: integer
          format: int32
        totalRows:
          type: integer
          format: int64
    ResponseLAG:
      title: ResponseLAG
      type: object
      properties:
        data:
          $ref: '#/components/schemas/LAG'
        endRow:
          type: integer
          format: int64
        errors:
          type: array
          items:
            type: object
          description: ''
        nextPage:
          type: string
          description: (Optional) A paged URL request pointing to the next page of data, or "null" if there is no next page.
        previousPage:
          type: string
          description: (Optional) A paged URL request pointing to the previous page of data, or "null" if there is no previous page.
        startRow:
          type: integer
          format: int64
        status:
          type: integer
          format: int32
        totalRows:
          type: integer
          format: int64
    ResponseListCardSlot:
      title: ResponseListCardSlot
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CardSlot'
          description: ''
        endRow:
          type: integer
          format: int64
        errors:
          type: array
          items:
            type: object
          description: ''
        nextPage:
          type: string
          description: (Optional) A paged URL request pointing to the next page of data, or "null" if there is no next page.
        previousPage:
          type: string
          description: (Optional) A paged URL request pointing to the previous page of data, or "null" if there is no previous page.
        startRow:
          type: integer
          format: int64
        status:
          type: integer
          format: int32
        totalRows:
          type: integer
          format: int64
    ResponseListCard:
      title: ResponseListCard
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Card'
          description: ''
        endRow:
          type: integer
          format: int64
        errors:
          type: array
          items:
            type: object
          description: ''
        nextPage:
          type: string
          description: (Optional) A paged URL request pointing to the next page of data, or "null" if there is no next page.
        previousPage:
          type: string
          description: (Optional) A paged URL request pointing to the previous page of data, or "null" if there is no previous page.
        startRow:
          type: integer
          format: int64
        status:
          type: integer
          format: int32
        totalRows:
          type: integer
          format: int64
    ResponseListLAGMemberDetails:
      title: ResponseListLAGMemberDetails
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/LAGMemberDetails'
          description: ''
        endRow:
          type: integer
          format: int64
        errors:
          type: array
          items:
            type: object
          description: ''
        nextPage:
          type: string
          description: (Optional) A paged URL request pointing to the next page of data, or "null" if there is no next page.
        previousPage:
          type: string
          description: (Optional) A paged URL request pointing to the previous page of data, or "null" if there is no previous page.
        startRow:
          type: integer
          format: int64
        status:
          type: integer
          format: int32
        totalRows:
          type: integer
          format: int64
    ResponseListLAG:
      title: ResponseListLAG
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/LAG'
          description: ''
        endRow:
          type: integer
          format: int64
        errors:
          type: array
          items:
            type: object
          description: ''
        nextPage:
          type: string
          description: (Optional) A paged URL request pointing to the next page of data, or "null" if there is no next page.
        previousPage:
          type: string
          description: (Optional) A paged URL request pointing to the previous page of data, or "null" if there is no previous page.
        startRow:
          type: integer
          format: int64
        status:
          type: integer
          format: int32
        totalRows:
          type: integer
          format: int64
    ResponseListNetworkElement:
      title: ResponseListNetworkElement
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/NetworkElement'
          description: ''
        endRow:
          type: integer
          format: int64
        errors:
          type: array
          items:
            type: object
          description: ''
        nextPage:
          type: string
          description: (Optional) A paged URL request pointing to the next page of data, or "null" if there is no next page.
        previousPage:
          type: string
          description: (Optional) A paged URL request pointing to the previous page of data, or "null" if there is no previous page.
        startRow:
          type: integer
          format: int64
        status:
          type: integer
          format: int32
        totalRows:
          type: integer
          format: int64
    ResponseListPhysicalLink:
      title: ResponseListPhysicalLink
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PhysicalLink'
          description: ''
        endRow:
          type: integer
          format: int64
        errors:
          type: array
          items:
            type: object
          description: ''
        nextPage:
          type: string
          description: (Optional) A paged URL request pointing to the next page of data, or "null" if there is no next page.
        previousPage:
          type: string
          description: (Optional) A paged URL request pointing to the previous page of data, or "null" if there is no previous page.
        startRow:
          type: integer
          format: int64
        status:
          type: integer
          format: int32
        totalRows:
          type: integer
          format: int64
    ResponseListPort:
      title: ResponseListPort
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Port'
          description: ''
        endRow:
          type: integer
          format: int64
        errors:
          type: array
          items:
            type: object
          description: ''
        nextPage:
          type: string
          description: (Optional) A paged URL request pointing to the next page of data, or "null" if there is no next page.
        previousPage:
          type: string
          description: (Optional) A paged URL request pointing to the previous page of data, or "null" if there is no previous page.
        startRow:
          type: integer
          format: int64
        status:
          type: integer
          format: int32
        totalRows:
          type: integer
          format: int64
    ResponseListRadioEquipment:
      title: ResponseListRadioEquipment
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/RadioEquipment'
          description: ''
        endRow:
          type: integer
          format: int64
        errors:
          type: array
          items:
            type: object
          description: ''
        nextPage:
          type: string
          description: (Optional) A paged URL request pointing to the next page of data, or "null" if there is no next page.
        previousPage:
          type: string
          description: (Optional) A paged URL request pointing to the previous page of data, or "null" if there is no previous page.
        startRow:
          type: integer
          format: int64
        status:
          type: integer
          format: int32
        totalRows:
          type: integer
          format: int64
    ResponseListShelf:
      title: ResponseListShelf
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Shelf'
          description: ''
        endRow:
          type: integer
          format: int64
        errors:
          type: array
          items:
            type: object
          description: ''
        nextPage:
          type: string
          description: (Optional) A paged URL request pointing to the next page of data, or "null" if there is no next page.
        previousPage:
          type: string
          description: (Optional) A paged URL request pointing to the previous page of data, or "null" if there is no previous page.
        startRow:
          type: integer
          format: int64
        status:
          type: integer
          format: int32
        totalRows:
          type: integer
          format: int64
    ResponseNetworkElement:
      title: ResponseNetworkElement
      type: object
      properties:
        data:
          $ref: '#/components/schemas/NetworkElement'
        endRow:
          type: integer
          format: int64
        errors:
          type: array
          items:
            type: object
          description: ''
        nextPage:
          type: string
          description: (Optional) A paged URL request pointing to the next page of data, or "null" if there is no next page.
        previousPage:
          type: string
          description: (Optional) A paged URL request pointing to the previous page of data, or "null" if there is no previous page.
        startRow:
          type: integer
          format: int64
        status:
          type: integer
          format: int32
        totalRows:
          type: integer
          format: int64
    ResponsePhysicalLink:
      title: ResponsePhysicalLink
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PhysicalLink'
        endRow:
          type: integer
          format: int64
        errors:
          type: array
          items:
            type: object
          description: ''
        nextPage:
          type: string
          description: (Optional) A paged URL request pointing to the next page of data, or "null" if there is no next page.
        previousPage:
          type: string
          description: (Optional) A paged URL request pointing to the previous page of data, or "null" if there is no previous page.
        startRow:
          type: integer
          format: int64
        status:
          type: integer
          format: int32
        totalRows:
          type: integer
          format: int64
    ResponsePort:
      title: ResponsePort
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Port'
        endRow:
          type: integer
          format: int64
        errors:
          type: array
          items:
            type: object
          description: ''
        nextPage:
          type: string
          description: (Optional) A paged URL request pointing to the next page of data, or "null" if there is no next page.
        previousPage:
          type: string
          description: (Optional) A paged URL request pointing to the previous page of data, or "null" if there is no previous page.
        startRow:
          type: integer
          format: int64
        status:
          type: integer
          format: int32
        totalRows:
          type: integer
          format: int64
    ResponseRadioEquipment:
      title: ResponseRadioEquipment
      type: object
      properties:
        data:
          $ref: '#/components/schemas/RadioEquipment'
        endRow:
          type: integer
          format: int64
        errors:
          type: array
          items:
            type: object
          description: ''
        nextPage:
          type: string
          description: (Optional) A paged URL request pointing to the next page of data, or "null" if there is no next page.
        previousPage:
          type: string
          description: (Optional) A paged URL request pointing to the previous page of data, or "null" if there is no previous page.
        startRow:
          type: integer
          format: int64
        status:
          type: integer
          format: int32
        totalRows:
          type: integer
          format: int64
    ResponseShelf:
      title: ResponseShelf
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Shelf'
        endRow:
          type: integer
          format: int64
        errors:
          type: array
          items:
            type: object
          description: ''
        nextPage:
          type: string
          description: (Optional) A paged URL request pointing to the next page of data, or "null" if there is no next page.
        previousPage:
          type: string
          description: (Optional) A paged URL request pointing to the previous page of data, or "null" if there is no previous page.
        startRow:
          type: integer
          format: int64
        status:
          type: integer
          format: int32
        totalRows:
          type: integer
          format: int64
    Shelf:
      title: Shelf
      required:
      - fdn
      - sourceType
      - sourceSystem
      - sources
      - name
      - neName
      - neId
      - positionId
      - position
      - adminState
      - operState
      - standbyState
      - availabilityStates
      type: object
      properties:
        links:
          type: array
          items:
            $ref: '#/components/schemas/Link'
          description: ''
          xml:
            namespace: http://www.w3.org/2005/Atom
            attribute: false
            wrapped: false
        fdn:
          type: string
          description: The Fully Distinguished Name of this Shelf.
        sourceType:
          allOf:
          - $ref: '#/components/schemas/SourceType7'
          - description: The type of the source system where this Shelf is sourced from.
        sourceSystem:
          type: string
          description: The source system where this Shelf is sourced from.
        sources:
          type: array
          items:
            type: string
          description: The Fully Distinguished Names of the Shelves from the source system associated to this Shelf.
        name:
          type: string
          description: The name of this Shelf, as defined by the source system.
        neName:
          type: string
          description: The name of the Network Element containing this Shelf, as defined by the source system.
        neId:
          type: string
          description: The id of the Network Element containing this Shelf, as defined by the source system.
        description:
          type: string
          description: The detailed description of this Shelf.
        positionId:
          type: integer
          description: The relative position of the Shelf, that determines the order in which to show it in the source system UI.
          format: int64
        position:
          type: string
          description: A formatted name that describes the position of the Shelf within the Network Element.
        adminState:
          allOf:
          - $ref: '#/components/schemas/AdminState6'
          - description: The administrative state of this Shelf. Refer to the X.731 standard.
        operState:
          allOf:
          - $ref: '#/components/schemas/OperState6'
          - description: The operational state of this Shelf. Refer to the X.731 standard.
        standbyState:
          allOf:
          - $ref: '#/components/schemas/StandbyState6'
          - description: The standby state of this Shelf. Refer to the X.731 standard.
        availabilityStates:
          type: array
          items:
            $ref: '#/components/schemas/AvailabilityState'
          description: The availability states of this Shelf. Refer to the X.731 standard.
        stateReasons:
          type: array
          items:
            type: string
          description: A set of specific reasons why the Shelf is in this state.
        objectDetails:
          type: object
          additionalProperties:
            type: string
          description: Generic properties of this Shelf, specific to the Network Supervision application.
        manufacturer:
          type: string
          description: The vendor of the Shelf.
        serialNumber:
          type: string
          description: The serial number of the Shelf provided by the manufacturer.
        partNumber:
          type: string
          description: The part number of the Shelf provided by the manufacturer.
        manufacturerAssemblyNumber:
          type: string
          description: The assembly number of the Shelf provided by the manufacturer.
        manufactureDate:
          type: string
          description: The date of manufacture of the Shelf.
        manufacturingDeviations:
          type: string
          description: The manufacturing deviations of the Shelf provided by the manufacturer.
        macAddress:
          type: string
          description: The Base MAC Address of the Shelf
        hwMacAddress:
          type: string
          description: The Hardware MAC Address of the Shelf
    ActualRateUnits:
      title: ActualRateUnits
      enum:
      - unknown
      - kbps
      - Mbps
      type: string
      description: The units associated to the 'actualRate' field value for this Physical Link. Default to 'unknown'.
      example: kbps
    ActualRateUnits1:
      title: ActualRateUnits1
      enum:
      - unknown
      - kbps
      - Mbps
      type: string
      description: The units associated to the 'actualRate' field value for this Port.
      example: kbps
    AdminState:
      title: AdminState
      enum:
      - unknown
      - unlocked
      - locked
      - forcedLockout
      - shuttingDown
      - maintenance
      type: string
      description: The administrative state of this Card. Refer to the X.731 standard.
      example: unlocked
    AdminState1:
      title: AdminState1
      enum:
      - unknown
      - unlocked
      - locked
      - forcedLockout
      - shuttingDown
      - maintenance
      type: string
      description: The administrative state of this Card Slot. Refer to the X.731 standard.
      example: unlocked
    AdminState2:
      title: AdminState2
      enum:
      - unknown
      - unlocked
      - locked
      - forcedLockout
      - shuttingDown
      - maintenance
      type: string
      description: The administrative state of this LAG. Refer to the X.731 standard.
      example: unlocked
    AdminState3:
      title: AdminState3
      enum:
      - unknown
      - unlocked
      - locked
      - forcedLockout
      - shuttingDown
      - maintenance
      type: string
      description: The administrative state of this Network Element. Refer to the X.731 standard.
      example: unlocked
    AdminState4:
      title: AdminState4
      enum:
      - unknown
      - unlocked
      - locked
      - forcedLockout
      - shuttingDown
      - maintenance
      type: string
      description: The adminstrative state of this Physical Link. Defaults to 'unknown'. Refer to the X.731 standard.
      example: unknown
    AdminState5:
      title: AdminState5
      enum:
      - unknown
      - unlocked
      - locked
      - forcedLockout
      - shuttingDown
      - maintenance
      type: string
      description: The administrative state of this Port. Refer to the X.731 standard.
      example: unlocked
    AdminState6:
      title: AdminState6
      enum:
      - unknown
      - unlocked
      - locked
      - forcedLockout
      - shuttingDown
      - maintenance
      type: string
      description: The administrative state of this Shelf. Refer to the X.731 standard.
      example: unlocked
    AvailabilityState:
      title: AvailabilityState
      enum:
      - unknown
      - inTest
      - failed
      - degraded
      - offLine
      - powerOff
      - offDuty
      - dependency
      - notInstalled
      - logFull
      type: string
    CommunicationState:
      title: CommunicationState
      enum:
      - unknown
      - up
      - down
      - partial
      type: string
      description: The communication status of this Network Element. Specifies if the management system can reach the Network Element, using one of its supported management protocols.
      example: up
    Direction:
      title: Direction
      enum:
      - unknown
      - uniDirectional
      - biDirectional
      type: string
      description: The direction of this Physical Link. Defaults to 'unknown'.
      example: uniDirectional
    EncapType:
      title: EncapType
      enum:
      - unknown
      - other
      - nullEncap
      - dot1q
      - qinq
      - mpls
      - bcpNull
      - bcpDot1q
      - ipcp
      - frameRelay
      - pppAuto
      - atm
      - wanMirror
      - ciscoHdlc
      - cem
      - rhdlc
      - raw
      - cellular
      - wlan
      type: string
      description: The encapsulation type of this LAG.
      example: nullEncap
    EncapType1:
      title: EncapType1
      enum:
      - unknown
      - other
      - nullEncap
      - dot1q
      - qinq
      - mpls
      - bcpNull
      - bcpDot1q
      - ipcp
      - frameRelay
      - pppAuto
      - atm
      - wanMirror
      - ciscoHdlc
      - cem
      - rhdlc
      - raw
      - cellular
      - wlan
      type: string
      description: The Encapsulation type of the port
      example: dot1q
    LagMode:
      title: LagMode
      enum:
      - undefined
      - access
      - trunk
      - hybrid
      type: string
      description: The mode of this LAG.
      example: access
    LatencyUnits:
      title: LatencyUnits
      enum:
      - unknown
      - nanoseconds
      - microseconds
      - milliseconds
      - seconds
      - minutes
      - hours
      - days
      type: string
      description: The units associated to the 'latency' field value for this Physical Link. Default to 'unknown'.
      example: nanoseconds
    ManagedState:
      title: ManagedState
      enum:
      - unknown
      - managed
      - preprovisioned
      - suspended
      - failed
      type: string
      description: The management state of this Network Element.
      example: managed
    NetworkType:
      title: NetworkType
      enum:
      - ext
      - unknown
      - ip
      - optical
      - wireless
      type: string
      description: The type of network this Network Element is part of.
      example: ip
    OperState:
      title: OperState
      enum:
      - unknown
      - enabled
      - disabled
      type: string
      description: The operational state of this Card. Refer to the X.731 standard.
      example: enabled
    OperState1:
      title: OperState1
      enum:
      - unknown
      - enabled
      - disabled
      type: string
      description: The operational state of this Card Slot. Refer to the X.731 standard.
      example: enabled
    OperState2:
      title: OperState2
      enum:
      - unknown
      - enabled
      - disabled
      type: string
      description: The operational state of this LAG. Refer to the X.731 standard.
      example: enabled
    OperState3:
      title: OperState3
      enum:
      - unknown
      - enabled
      - disabled
      type: string
      description: The operational state of this Network Element. Refer to the X.731 standard.
      example: enabled
    OperState4:
      title: OperState4
      enum:
      - unknown
      - enabled
      - disabled
      type: string
      description: The operational state of this Physical Link. Read only. Defaults to 'unknown'. Refer to the X.731 standard.
    OperState5:
      title: OperState5
      enum:
      - unknown
      - enabled
      - disabled
      type: string
      description: The operational state of this Port. Refer to the X.731 standard.
      example: enabled
    OperState6:
      title: OperState6
      enum:
      - unknown
      - enabled
      - disabled
      type: string
      description: The operational state of this Shelf. Refer to the X.731 standard.
      example: enabled
    PortMode:
      title: PortMode
      enum:
      - undefined
      - access
      - trunk
      - hybrid
      type: string
      description: The mode of port.
      example: access
    PortType:
      title: PortType
      enum:
      - ext
      - unknown
      - none
      - other
      - ethernet
      - sonet
      - virtual
      - sonetChannel
      - tdm
      - radio
      - wireless
      - serial
      - voice
      - wdm
      - gpon
      - dsl
      - otu
      - sdh
      - connector
      - coherentOptical
      - otClient
      - otLine
      type: string
      description: The type of this Port.
      example: ethernet
    Protection:
      title: Protection
      enum:
      - unknown
      - Unprotected
      - Protected
      type: string
      description: Indicates if this Physical Link is protected or unprotected. Defaults to 'unknown'.
      example: Protected
    ProtectionKind:
      title: ProtectionKind
      enum:
      - unknown
      - oneToOne
      - oneToMany
      - opsaProtected
      - opsbProtected
      - yCableProtected
      - esncpSncI
      - esncpSncN
      - esncpSncS
      - omsp
      - olp
      type: string
      description: The type of protection for this Physical Link. Defaults to 'unknown'.
      example: unknown
    Restoration:
      title: Restoration
      enum:
      - unknown
      - none
      - sourceBased
      - guaranteed
      type: string
      description: The restoration type for this Physical Link. Defaults to 'unknown'.
      example: unknown
    ResyncState:
      title: ResyncState
      enum:
      - unknown
      - inProgress
      - done
      - failed
      - requested
      - notAttempted
      type: string
      description: The resynchronization status of this Network Element.
      example: done
    SourceType:
      title: SourceType
      enum:
      - other
      - nsd
      - nfmp
      - nfmt
      - nrcp
      - nrct
      - nrcf
      - nrcx
      - mdm
      - nsp
      type: string
      description: The type of the source system where this Card is sourced from.
      example: nfmp
    SourceType1:
      title: SourceType1
      enum:
      - other
      - nsd
      - nfmp
      - nfmt
      - nrcp
      - nrct
      - nrcf
      - nrcx
      - mdm
      - nsp
      type: string
      example: nfmp
    SourceType2:
      title: SourceType2
      enum:
      - other
      - nsd
      - nfmp
      - nfmt
      - nrcp
      - nrct
      - nrcf
      - nrcx
      - mdm
      - nsp
      type: string
      description: The type of the source system where this Card Slot is sourced from.
      example: nfmp
    SourceType3:
      title: SourceType3
      enum:
      - other
      - nsd
      - nfmp
      - nfmt
      - nrcp
      - nrct
      - nrcf
      - nrcx
      - mdm
      - nsp
      type: string
      description: The type of the source system where this LAG is sourced from.
      example: nfmp
    SourceType4:
      title: SourceType4
      enum:
      - other
      - nsd
      - nfmp
      - nfmt
      - nrcp
      - nrct
      - nrcf
      - nrcx
      - mdm
      - nsp
      type: string
      description: The type of the source system where this Network Element is sourced from.
      example: nfmp
    SourceType5:
      title: SourceType5
      enum:
      - other
      - nsd
      - nfmp
      - nfmt
      - nrcp
      - nrct
      - nrcf
      - nrcx
      - mdm
      - nsp
      type: string
      description: The type of the source system where this Port is sourced from.
      example: nfmp
    SourceType7:
      title: SourceType7
      enum:
      - other
      - nsd
      - nfmp
      - nfmt
      - nrcp
      - nrct
      - nrcf
      - nrcx
      - mdm
      - nsp
      type: string
      description: The type of the source system where this Shelf is sourced from.
      example: nfmp
    StandbyState:
      title: StandbyState
      enum:
      - providingService
      - standby
      type: string
      description: The standby state of this Card. Refer to the X.731 standard.
      example: providingService
    StandbyState1:
      title: StandbyState1
      enum:
      - providingService
      - standby
      type: string
      description: The standby state of this Card Slot. Refer to the X.731 standard.
      example: providingService
    StandbyState2:
      title: StandbyState2
      enum:
      - providingService
      - standby
      type: string
      description: The standby state of this LAG. Refer to the X.731 standard
      example: providingService
    StandbyState3:
      title: StandbyState3
      enum:
      - providingService
      - standby
      type: string
      description: The standby state of this Network Element. Refer to the X.731 standard.
      example: providingService
    StandbyState4:
      title: StandbyState4
      enum:
      - providingService
      - standby
      type: string
      description: The standby state of this Physical Link. Defaults to 'providingService'. Refer to the X.731 standard.
      example: providingService
    StandbyState5:
      title: StandbyState5
      enum:
      - providingService
      - standby
      type: string
      description: The standby state of this Port. Refer to the X.731 standard.
      example: providingService
    StandbyState6:
      title: StandbyState6
      enum:
      - providingService
      - standby
      type: string
      description: The standby state of this Shelf. Refer to the X.731 standard.
      example: providingService
    Type:
      title: Type
      enum:
      - physicalPort
      - networkElement
      - lag
      type: string
      description: The type of this Physical Link Endpoint. Mandatory property for creation.
      example: physicalPort
    Content-Type:
      title: Content-Type
      enum:
      - application/json
      type: string
  securitySchemes:
    RESTToken:
      type: apiKey
      name: Authorization
      in: header
security: []
tags:
- name: cardSlots
  description: Cards Slots
- name: cards
  description: Cards
- name: lags
  description: Link Aggregation Groups
- name: networkElements
  description: Network Elements
- name: physicalLinks
  description: Physical Links
- name: ports
  description: Ports
- name: radioEquipment
  description: Radio Equipment
- name: shelves
  description: Shelves